https://github.com/markkos89/node-mysql-auth-boilerplate

Node + Express + JWT + Morgan + Winston + Sequelize + Swagger DOC
https://github.com/markkos89/node-mysql-auth-boilerplate

Last synced: about 1 year ago
JSON representation

Node + Express + JWT + Morgan + Winston + Sequelize + Swagger DOC

• Host: GitHub
• URL: https://github.com/markkos89/node-mysql-auth-boilerplate
• Owner: Markkos89
• License: mit
• Created: 2021-04-12T11:14:22.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-12T11:18:12.000Z (about 5 years ago)
• Last Synced: 2025-02-13T07:33:01.056Z (over 1 year ago)
• Language: JavaScript
• Size: 61.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)

# node-mysql-auth-boilerplate

____

Node(Express), MySql based app with Authentication Boilerplate.\

It can be used in the start of any project to have JWT authentication.

## How to install

1. clone the repo

2. run ```npm install```

3. create ```.env``` file as given in ```.env.example```

4. enter your database configs in ```.env``` at least for development in local.

5. run ```npx sequelize db:create``` It will create database for you.

6. run ```npx sequelize db:migrate``` It will create tables.

7. run ```npm run dev```

### Boilerplate includes

- [x] Server with Express.js

- [x] Database schema and models using Sequelize ORM.

- [x] User authentication with JWT.

- [x] StandardJs for coding standards and styling.

- [x] Request validation using Express-validator.

- [x] Morgan and Winston for server side logging.

- [x] Swagger for API documentation.