https://github.com/filipe1309/rs-nodejs-nps-api
This app was developed during NLW 4.0 (Next Level Week), and aims to simulate an NPS (Net Promoter Score) API using NodeJS
https://github.com/filipe1309/rs-nodejs-nps-api
nlw nlw-4 nodejs nps rocketseat typescript
Last synced: 7 months ago
JSON representation
This app was developed during NLW 4.0 (Next Level Week), and aims to simulate an NPS (Net Promoter Score) API using NodeJS
- Host: GitHub
- URL: https://github.com/filipe1309/rs-nodejs-nps-api
- Owner: filipe1309
- Created: 2021-02-22T16:34:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-28T17:54:02.000Z (over 4 years ago)
- Last Synced: 2025-01-17T00:48:23.553Z (9 months ago)
- Topics: nlw, nlw-4, nodejs, nps, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 405 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Rocktseat NodeJS NPS API
This app was developed during NLW 4.0 (Next Level Week), and aims to simulate an NPS (Net Promoter Score) API using NodeJS.
## 💻 Technologies
- [NodeJS](https://nodejs.org/) _(v14.14.0)_
- [Express](https://expressjs.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Nodemailer](https://nodemailer.com/) _(Email sending)_
- [Ethereal](https://ethereal.email/) _(Fake SMTP service)_
- [TypeORM](https://typeorm.io/#/)
- [Handlebarsjs](https://handlebarsjs.com/) _(Email template)_
- [Yup](https://github.com/jquense/yup) _(Schema validation)_
- [Jest](https://jestjs.io/)
- [Supertest](https://www.npmjs.com/package/supertest)
## 🧰 Architecture
### Database
## 💿 Installation
```sh
# Install dependencies
yarn
# Run migrations to create SQLite database
yarn typeorm migration:run
```
## 🏃 Running
```sh
yarn dev
```
## ✅ Tests
```sh
yarn test
```