README.md

nodejs-api-boilerplate

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

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

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!

Features

• 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

Built With

This section show's list of major frameworks/libraries/modules used to bootstrap this project.

• 
• 
• 
• 
• 
• 
• 

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

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

Installation

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.

1. Clone the repo

   https://github.com/maksof-jawad/nodejs-api-boilerplate.git

2. Install npm packages

   npm install

3. create a database

   edit dbconfig in app/config/db-config

4. Run your Application index.js

   npm start or nodemon

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Email - contact.syedjawad - @example.com

Project Link: https://github.com/maksof-jawad/nodejs-api-boilerplate

𝚂𝚑𝚘𝚠 𝚜𝚘𝚖𝚎 ❤️ 𝚋𝚢 𝚜𝚝𝚊𝚛𝚛𝚒𝚗𝚐 this 𝚛𝚎𝚙𝚘𝚜𝚒𝚝𝚘𝚛𝚒𝚎𝚜!

Credits: Maksof Jawad

Last Edited on: 10/14/2022