A Node.js API to calculate a company NPS (Net Promoter Score).
The nps-calculator is an API where you can register user, survey, send email to users answer the surveys and then the API calculates the NPS.
Prerequisites:
Download and install Node.js and Yarn.
- First, clone the repository:
git clone https://github.com/erickmp07/nps-calculator.git- Install its dependencies with
yarncommand:
cd nps-calculator
yarnPrerequisites:
Download and install Docker.
- First, pull the image with the command:
docker pull erickmp07/nps-calculator:latestStart the server:
yarn devNote: To run the tests:
yarn testThe application can be accessed at localhost:3333.
Run the image with the command:
docker run -p 49160:3333 -d erickmp07/nps-calculatorThe application can be accessed at localhost:49160.
This project was developed with the following technologies:
The available routes are:
# POST (JSON) - Create User
http:https://localhost:{port}/users
body: {
"name": "username",
"email": "[email protected]"
}
# POST (JSON) - Create Survey
http:https://localhost:{port}/surveys
body: {
"title": "title",
"description": "description"
}
# GET - Show Surveys
http:https://localhost:{port}/surveys
# POST (JSON) - Send Mail
http:https://localhost:{port}/sendMail
body: {
"email": "user_email",
"survey_id": "survey_id"
}
# GET - Answer Survey
http:https://localhost:{port}/answers/:value
# GET - Calculate NPS
http:https://localhost:{port}/nps/:survey_idPRs and stars are always welcome.
To ask a question, please contact me.
Licensed under MIT license.