1.2.3 • Published 1 year ago

@gulali/nodejs-express-sequelize-mysql-api-boilerplate v1.2.3

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

nodejs-express-mysql-api-boilerplate

a simple boilerplate for nodejs express mysql api clone this repo and start your project

Installation

npx @gulali/nodejs-express-sequelize-mysql-api-boilerplate my-project-api

Usage

Database configuration

edit config/config.json file and change your database name, username and password

{
  "development": {
    "username": "root",
    "password": "",
    "database": "api_db_development",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "test": {
    "username": "root",
    "password": "",
    "database": "api_db_test",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "production": {
    "username": "root",
    "password": "",
    "database": "api_db_production",
    "host": "127.0.0.1",
    "dialect": "mysql"
  }
}

and run this command to create database and tables

npm run prepare

Run the project

npm run start:dev

Model Generation

npx sequelize-cli model:generate --name user --attributes firstname:string,lastname:string,username:string,email:string,password:string,gender:string,active:integer,deleted:integer,token:string,token_expire:string,birthday:date,role:string

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.