/expressjs-boilerplate

This repository was created for building an API using expressjs with Sequelize ORM - MySql RDBMS. Feel free to fork and clone.

Primary LanguageJavaScript

ExpressJs Boilerplate For Building API with Sequelize ORM && mysql RDBMS

This is a boilerplate for implementing API using ExpressJS Node.js framework and mysql DBMS with Sequelize ORM. In this project, we will use yarn for node package management.

dependencies

Setup Guide

To get started with the project, you need to clone the repository and open the project and copy the .env.example to .env and make sure you put your own database configuration and the last thing you are going to do is run yarn install to install the dependencies.

# clone the repository
$ git clone https://github.com/virakkhun/expressjs-boilerplate-sequelize-mysql.git
# go into the repository
$ cd expressjs-boilerplate-sequelize-mysql
# copy the .env.example to .env
$ cp .env.example .env
# install the dependencies
$ yarn install

Run Project

# to run the project
$ yarn start

Open you browser and paste the below url into the search bar

http://localhost:3000/user/your_own_name