Node.js API boilerplate with JWT and Sequelize

Node.js REST API boilerplate with authentication for your next project.

Report bug · Request feature

Table of contents

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About

I needed an API boilerplate to kickstart my projects. I built this repo for me to be able to use it as a template when I need to create an API for a personal project.

Features included :

• Authentication through JWT (access_token and refresh_token)
• Sequelize CLI to create additional tables

Built With

• Express
• Node.js
• Sequelize
• Sequelize CLI

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• npm
• Node.js
• Database working with Sequelize (postgres, mysql, mariadb, sqlite3 or tedious)

Installation

1. Clone the repo

   git clone https://github.com/jeremyhalin/node-api-jwt-sequelize-boilerplate.git

2. Install NPM packages

   npm install

3. Create .env file

   cp .env.example .env

Usage

1. Start your database

2. Start server

   npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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. See LICENSE for more information.

Acknowledgements

• Img Shields
• Choose an Open Source License
• gitmoji
• Best-README-Template
• nodemon
• jsonwebtoken
• http-status-codes
• Best-README-Template