README.md

Node.js REST API

Node.js REST API with:

• JWT Authentication ( jsonwebtoken )
• Mail Service ( nodemailer )
• Queue jobs ( kue, Redis)
• Validation ( joi )
• MongoDB ( mongoose )
• Error reporting (dev-mode) ( youch )
• Error tracking (production-mode) ( sentry )

Getting Started

1. Clone the repository.
2. You will need Mongo installed in your machine or a docker container (mongo image recommended).
3. You will need Redis installed in your machine or a docker container (redis:alpine image recommended).
4. Setup the environment variables (dotenv). Rename file .env-example to just .env and fill in the variables. *Remember to change NODE_ENV to production if you host it online. *You will need a sentry.io account for Error tracking.
5. In root folder run npm install.
6. In root folder run npm start.