Welcome to nodejs-supreme-api 👋

Version Postgres Redis License: (MIT)

nodejs-supreme-api it's a nodejs project that applies best coding practices and could be used as structure to you create your APIs. I hope you enjoy !

Features

✅ Eslint, Prettier, EditorConfig
✅ ORM Sequelize
✅ Auth Middleware with JWT
✅ File Upload
✅ Nodemailer
✅ Queues with Redis
✅ Error Monitoring
✅ Tests with Jest and Supertest

Services

This project implements a mailing and error monitoring features, so to run properly you should create an account in following services and set enviroment variables values

API Request

ForAPI documentation and request examples simple run:

npx serve .\docs\api\

Install

docker-compose -f .\docker-compose.yml up -d
yarn install

Postgres

sequelize db:migrate
yarn sequelize db:seed

Usage

yarn dev

Run tests

yarn test

Author

👤 Jefferson Amorim

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Jefferson Amorim.
This project is (MIT) licensed.