ycpatel813/express-mongo-jwt-boilerplate

Express Mongo JsonWebToken boilerplate

Express Mongo JWT Boilerplate

Installation

• Install NodeJS, MongoDB
• Install npm or yarn
• Rename .env.example to .env
• Fulfill .env data
• Start MongoDB
• Run yarn run dev or npm run dev
• Check http://localhost:3000/api/status to see it works

With Docker

• Make sure you have installed Docker and Docker Compose
• Just run docker-compose up to start the server

Note when setting transporter in .env

• TRANSPORTER_SERVICE can be for example gmail but also SMTP of your server
• TRANSPORTER_EMAIL is email from which mails will be sent
• TRANSPORTER_PASSWORD is password to above email
  • if gmail you need to generate special app-password, see for further support: https://support.google.com/mail/answer/185833?hl=en)

Changes from original project

• Fixed deprecation warnings with mongoose usage.
• Updated dependencies to fix vulnerabilities.
• Added email confirmation after registration.

TODO

• Split users and admins to two collections:
  • Rename auth.controller.js to user.controller.js
  • create user.route.js and refactor auth.route.js to contain only this demonstration "/secret" routes
• Integrate Swagger UI documentation
• Write unit tests