boilerplate to kickstart your clean architecture node.js projects ( JavaScript+ Express + Sequelize + JWT and more )
Explore the docs ยป
Report Bug
ยท
Request Feature
Table of Contents
You can use this template when you're starting a new project. It contains general concepts, you can customize it according to your needs.
A boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and mySql.
You will get a production-ready Node.js app installed and configured on your machine. The app comes with many built-in features, such as authentication using JWT, request validation, error handling, logging, API documentation, image uploading, email sending, etc.
Social logins (Google & Apple), unit and integration tests, in-app purchases (Google&Apple), daily crons, notifications (firebase), pagination, etc could be added in the future. Get ready for more, star it and wait!
- SQL database : mySql using sequelize
- Authentication and authorization : using JWT (access and refresh token)
- Validation : request data validation using Joi
- Error handling: error handling mechanism with specific result messages and codes
- Environment variables: using dotenv
- CORS: Cross-Origin Resource-Sharing enabled using cors
- and so on
This section show's list of major frameworks/libraries/modules used to bootstrap this project.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- apidoc (Optional To create Api Documentation)
apidoc -i app -o apidoc
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Clone the repo
https://github.com/maksof-jawad/nodejs-api-boilerplate.git
- Install npm packages
npm install
- create a database
edit dbconfig in app/config/db-config
- Run your Application
index.js
npm start or nodemon
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License.
Email - contact.syedjawad - @example.com
Project Link: https://github.com/maksof-jawad/nodejs-api-boilerplate
Credits: Maksof Jawad
Last Edited on: 10/14/2022