A minial boilerplate code for nodejs, mongodb and typescript.

The idea behind this project lies in simplicity. It is the template for a generic API with the implementation of user registration and authorization. It's just a sample of how to write a service, feel free to use this project whatever way you need.

Clone the project

  git clone https://github.com/mitulp236/node-express-mongo-typescript-boilerplate.git

Go to the project directory

  cd node-mongo-typescript-boilerplate

Install dependencies

  yarn install

Start the server

  yarn dev

BASE API: http://localhost:4000/api/

API DOCS (Swagger): http://localhost:4000/api-docs/

To run this project, you will need to add the following environment variables to your .env file

PORT DATABASEURI HOST_NAME FRONT_END_BASE_URL

If you want to setup email, then add below variables as well.

MAIL_DRIVER MAIL_HOST MAIL_PORT MAIL_USERNAME MAIL_PASSWORD MAIL_ENCRYPTION MAIL_FROM_NAME MAIL_FROM_ADDRESS

Tools & Technologies: Node, Express, Typescript, Mongodb, Mongoose, Swagger, Nodemailer

Contributions are always welcome! ❤️

If you like the project enough to collaborate and you see some improvements to be made, please create a Pull Request.

Please adhere to this project's code of conduct.

Truth can only be found in one place: the code. ― Robert C. Martin,

For support, email [email protected]