ariakm25/Express-API-Sequelize-Starter

Nodejs REST API Starter built using Express, Sequelize, JsonWebToken & Swagger

Express Rest API Starter

---

📝 Table of Contents

• About
• Getting Started
• Usage

🧐 About

Nodejs REST API Starter built using Express, Sequelize, JsonWebToken & Swagger

Demo API Documentation

🏁 Getting Started

Prerequisites

Install:

• NodeJs
• MySQL

npm i -g sequelize-cli

Installing

1. Install dependencies

npm install

2. Copy & modify environment variables from .env.example to .env

cp .env.example .env

3. Migrate database

sequelize db:migrate

4. Seed to database

sequelize db:seed:all

🔧 Running the app

run:

npm start

or run on development mode:

npm run dev

🎈 Usage

Read API Documentation on browser: http://localhost:5000/docs

⛏️ Built Using

• MySQL - Database
• Sequelize - Database ORM
• Express - Server Framework
• NodeJs - Server Environment
• Swagger - API Documentation