NodeJs Template 🚀

This is a simple nodejs, express boilerplate that comes with pretty much anything you need to build small and robust express applications.

Table of Contents 🧰

• NodeJs Template 🚀
  • Table of Contents 🧰
  • Features 🔦
  • Installation 💽
  • Contributing ❤️
  • License 🧐
  • Contibutors 👨‍

Features 🔦

This template comes with bunch of ready made configurations like

1. Rate Limiter
2. Error Middleware to catch errors anywhere in your entire application.
3. Not Found Middleware to catch undefined routes or methods.
4. Config module to specify simple configurations
5. Error and App constants to store error messages and app constants.
6. Logger module to log errors and info to the console or file.
7. Dockerfile to build a docker image of the application.
8. Prisma ORM to interact with the database.
9. Swagger documentation to document the API.
10. Jest and Supertest for testing the application.
11. Service base architecture to structure the application.
12. Eslint and Prettier to enforce code style and formatting.
13. Feature based architecture to structure the application.

Installation 💽

Clone the repository

git clone https://github.com/Adedoyin-Emmanuel/nodejs-template.git .

Install the dependencies

npm install

Start the development server

npm run dev

Contributing ❤️

If you'd like to contribute to nodejs-template, please follow these steps:

1. Fork the repository
2. Create a new branch
3. Make your changes and commit them
4. Push your changes to your fork
5. Create a pull request :)

License 🧐

NodeJs-Template is licensed under the MIT License.

Contibutors 👨‍

Adedoyin Emmanuel Adeniyi