{"id":19742288,"url":"https://github.com/tavareshenrique/nps-api-nlw","last_synced_at":"2026-05-08T03:08:05.779Z","repository":{"id":105064080,"uuid":"341423178","full_name":"tavareshenrique/nps-api-nlw","owner":"tavareshenrique","description":"NPS é uma API criada utilizando NodeJS e TypeScript durante a NLW#4 da Rocketseat.","archived":false,"fork":false,"pushed_at":"2021-02-28T21:32:55.000Z","size":188,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-10T20:18:07.605Z","etag":null,"topics":["nlw","nlw-4","nodejs","nps-api","rocketseat","rocketseat-nlw","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tavareshenrique.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-23T04:04:06.000Z","updated_at":"2022-06-13T21:53:43.000Z","dependencies_parsed_at":"2023-12-01T14:18:03.085Z","dependency_job_id":null,"html_url":"https://github.com/tavareshenrique/nps-api-nlw","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tavareshenrique%2Fnps-api-nlw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tavareshenrique%2Fnps-api-nlw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tavareshenrique%2Fnps-api-nlw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tavareshenrique%2Fnps-api-nlw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tavareshenrique","download_url":"https://codeload.github.com/tavareshenrique/nps-api-nlw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241072504,"owners_count":19904782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nlw","nlw-4","nodejs","nps-api","rocketseat","rocketseat-nlw","typescript"],"created_at":"2024-11-12T01:29:56.850Z","updated_at":"2025-11-23T03:02:23.532Z","avatar_url":"https://github.com/tavareshenrique.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/tavareshenrique/nps-api-nlw/ce0018504a75455981215a7e1278101e79edc00c/assets/images/logo.svg\" alt=\"NPS API\" width=\"280\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://www.linkedin.com/in/tavareshenrique/\"\u003e\n      \u003cimg alt=\"Henrique Tavares\" src=\"https://img.shields.io/badge/-Henrique Tavares-BB1A34?style=flat\u0026logo=Linkedin\u0026logoColor=white\" /\u003e\n   \u003c/a\u003e\n \u003cimg alt=\"Repository size\" src=\"https://img.shields.io/github/repo-size/tavareshenrique/nps-api-nlw?color=BB1A34\"\u003e\n\n  \u003ca aria-label=\"Last Commit\" href=\"https://github.com/tavareshenrique/nps-api-nlw/commits/master\"\u003e\n    \u003cimg alt=\"Last commit on GitHub\" src=\"https://img.shields.io/github/last-commit/tavareshenrique/nps-api-nlw?color=BB1A34\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/tavareshenrique/nps-api-nlw/commits/master\"\u003e\n    \u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/tavareshenrique/nps-api-nlw?color=BB1A34\"\u003e\n  \u003c/a\u003e\n  \u003cimg alt=\"License\" src=\"https://img.shields.io/badge/license-MIT-BB1A34\"\u003e\n\u003c/p\u003e\n\n\u003e \u003cb\u003eNPS API\u003c/b\u003e é uma API criada utilizando NodeJS com Express e TypeScript durante a NLW#4 da [Rocketseat](https://github.com/Rocketseat). Esse projeto permite o calculo de NPS de uma empresa enviado por usuários via email.\n\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003e\u003cstrong\u003eNPS API\u003c/strong\u003e foi desenvolvido com ❤︎ pelo\n    \u003ca href=\"https://github.com/tavareshenrique\"\u003eHenrique Tavares\u003c/a\u003e\n  \u003c/sub\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\" style=\"margin-top: 16px\" \u003e\u003ca href=\"https://insomnia.rest/run/?label=NPS%20API\u0026uri=https%3A%2F%2Fraw.githubusercontent.com%2Ftavareshenrique%2Fnps-api-nlw%2Fmain%2Fassets%2FInsomnia_2021-02-28.json\" target=\"_blank\"\u003e\u003cimg src=\"https://insomnia.rest/images/run.svg\" alt=\"Run in Insomnia\"\u003e\u003c/a\u003e\u003c/div\u003e\n\n# :pushpin: Conteúdo\n\n- [API](#floppy_disk-api)\n  - [NPS](#nps)\n    - [Calculate](#calculate)\n  - [Mail](#mail)\n    - [Send Mail](#send-mail)\n  - [Survey](#survey)\n    - [Create Survey](#create-survey)\n    - [List All Surveys](#list-all-survey)\n  - [Users](#user)\n    - [Create User](#create-user)\n- [Tecnologias](#computer-tecnologias)\n- [Executando](#construction_worker-executando)\n- [Autores](#computer-autores)\n- [Licença](#closed_book-licença)\n\n# :floppy_disk: API\n\n# NPS\n\n## Calculate\n\nEsse End-Point para calcular o NPS.\n\n- **URL**\n\n  `/nps/:surveyId`\n\n- **Method:**\n\n  `GET`\n\n- **URL Params**\n\n  - **Required:**\n\n    `:surveyId` **-\u003e ID do survey.**\n\n- **Success Response:**\n\n  - **Code:** 200 \u003cbr /\u003e\n    **Content:**\n\n    ```json\n    {\n      \"detractor\": 1,\n      \"pasive\": 0,\n      \"promoters\": 2,\n      \"totalAnswers\": 3,\n      \"nps\": 33.33\n    }\n    ```\n\n---\n\n# Mail\n\n## Send Mail\n\nEnviar email.\n\n- **URL**\n\n  `/sendMail`\n\n- **Method:**\n\n  `POST`\n\n- **JSON Example:**\n\n  ```json\n  {\n    \"email\": \"henrique@email.com\",\n    \"survey_id\": \"eeb3d144-df68-4f5c-8ae2-5d498a2db412\"\n  }\n  ```\n\n- **Success Response:**\n\n  - **Code:** 200 \u003cbr /\u003e\n    **Content:**\n\n    ```json\n    {\n      \"id\": \"13e43459-f251-499c-a5b5-1f18c5aac461\",\n      \"user_id\": \"ada144d3-2164-40e6-b410-cb6f6f87c98d\",\n      \"survey_id\": \"eeb3d144-df68-4f5c-8ae2-5d498a2db412\",\n      \"created_at\": \"2021-02-28T00:36:15.000Z\"\n    }\n    ```\n\n---\n\n# Survey\n\n## Create Survey\n\nCriando pesquisa.\n\n- **URL**\n\n  `/surveys`\n\n- **Method:**\n\n  `POST`\n\n- **JSON Example:**\n\n  ```json\n  {\n    \"title\": \"Queromos ouvir sua opinião!\",\n    \"description\": \"De 0 à 10, quanto você recomendaria a nossa empresa?\"\n  }\n  ```\n\n- **Success Response:**\n\n  - **Code:** 200 \u003cbr /\u003e\n    **Content:**\n\n    ```json\n    {\n      \"id\": \"eeb3d144-df68-4f5c-8ae2-5d498a2db412\",\n      \"title\": \"Queromos ouvir sua opinião!\",\n      \"description\": \"De 0 à 10, quanto você recomendaria o Henrique?\",\n      \"created_at\": \"2021-02-25T16:31:06.000Z\"\n    }\n    ```\n\n---\n\n## List All Surveys\n\nListar todas pesquisas criadas.\n\n- **URL**\n\n  `/surveys`\n\n- **Method:**\n\n  `GET`\n\n- **Success Response:**\n\n  - **Code:** 200 \u003cbr /\u003e\n    **Content:**\n\n    ```json\n    [\n      {\n        \"id\": \"eeb3d144-df68-4f5c-8ae2-5d498a2db412\",\n        \"title\": \"Queromos ouvir sua opinião!\",\n        \"description\": \"De 0 à 10, quanto você recomendaria a nossa empresa?\",\n        \"created_at\": \"2021-02-25T16:31:06.000Z\"\n      }\n    ]\n    ```\n\n---\n\n# User\n\n## Create User\n\nEsse End-Point permite a criação de usuários.\n\n- **URL**\n\n  `/users`\n\n- **Method:**\n\n  `POST`\n\n- **JSON Example:**\n\n  ```json\n  {\n    \"name\": \"Henrique Tavares\",\n    \"email\": \"henrique@email.com\"\n  }\n  ```\n\n- **Success Response:**\n\n  - **Code:** 200 \u003cbr /\u003e\n    **Content:**\n\n    ```json\n    {\n      \"id\": \"3e837e85-90d2-4da0-8ce4-91e575d28c54\",\n      \"name\": \"Henrique Tavares\",\n      \"email\": \"henrique@email.com\",\n      \"created_at\": \"2021-02-28T21:24:14.000Z\"\n    }\n    ```\n\n---\n\n# :computer: Tecnologias\n\nEste projeto foi feito utilizando as seguintes tecnologias:\n\n- [NodeJS](https://github.com/nodejs/node)\n- [Express](https://github.com/expressjs/express)\n- [TypeScript](https://github.com/microsoft/TypeScript)\n- [express-async-errors](https://github.com/davidbanham/express-async-errors)\n- [handlebars](https://github.com/handlebars-lang/handlebars.js)\n- [nodemailer](https://github.com/nodemailer/nodemailer)\n- [reflect-metadata](https://github.com/rbuckton/reflect-metadata)\n- [sqlite3](https://github.com/sqlite/sqlite)\n- [uuid](https://github.com/uuidjs/uuid)\n- [yup](https://github.com/jquense/yup)\n- [jest](https://jestjs.io/)\n- [supertest](https://github.com/visionmedia/supertest)\n- [ts-jest](https://github.com/kulshekhar/ts-jest)\n- [ts-node-dev](https://github.com/wclr/ts-node-dev)\n\n# :construction_worker: Executando\n\n**Passo 1:**\n\n```bash\n# Clone o Repositório\n$ git@github.com:tavareshenrique/nps-api-nlw.git\n```\n\n**Passo 2:**\n\n```bash\n# Baixe as dependências\nyarn\n```\n\n**Passo 3:**\n\n```bash\n# Execute o projeto\nyarn dev\n```\n\n# :computer: Autores\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"http://github.com/tavareshenrique/\"\u003e\n        \u003cimg src=\"https://avatars1.githubusercontent.com/u/27022914?v=4\" width=\"100px;\" alt=\"Henrique Tavares\"/\u003e\n        \u003cbr /\u003e\n        \u003csub\u003e\n          \u003cb\u003eHenrique Tavares\u003c/b\u003e\n        \u003c/sub\u003e\n       \u003c/a\u003e\n       \u003cbr /\u003e\n       \u003ca href=\"https://www.linkedin.com/in/tavareshenrique/\" title=\"Linkedin\"\u003e@tavareshenrique\u003c/a\u003e\n       \u003cbr /\u003e\n       \u003ca href=\"https://github.com/tavareshenrique/fastfeet-api/commits?author=tavareshenrique\" title=\"Code\"\u003e💻\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"http://github.com/tavareshenrique/\"\u003e\n        \u003cimg src=\"https://avatars0.githubusercontent.com/u/28929274?s=200\u0026v=4\" width=\"100px;\" alt=\"Henrique Tavares\"/\u003e\n        \u003cbr /\u003e\n        \u003csub\u003e\n          \u003cb\u003eRocketseat\u003c/b\u003e\n        \u003c/sub\u003e\n       \u003c/a\u003e\n       \u003cbr /\u003e\n       \u003ca href=\"https://github.com/Rocketseat\" title=\"Linkedin\"\u003e@Rocketseat\u003c/a\u003e\n       \u003cbr /\u003e\n       \u003ca href=\"https://github.com/tavareshenrique/fastfeet-api/commits?author=tavareshenrique\" title=\"Creators\"\u003e🚀\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n# :closed_book: Licença\n\nEste projeto está sob a licença [MIT](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftavareshenrique%2Fnps-api-nlw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftavareshenrique%2Fnps-api-nlw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftavareshenrique%2Fnps-api-nlw/lists"}