Node.js API boilerplate with JWT and Sequelize
Node.js REST API boilerplate with authentication for your next project.
Table of contents
Table of Contents
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_tokenandrefresh_token) - Sequelize CLI to create additional tables
Built With
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
-
Clone the repo
git clone https://github.com/jeremyhalin/node-api-jwt-sequelize-boilerplate.git
-
Install NPM packages
npm install
-
Create
.envfilecp .env.example .env
Usage
-
Start your database
-
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.
- 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
License
Distributed under the MIT License. See LICENSE for more information.