express-sequelize-boilerplate

This is a simple boilerplate for building REST APIs in Node.js using Express. Intended for use with PostgreSQL using Sequelize ORM.

Getting Started

Clone the repository

git clone https://github.com/gadfaria/express-sequelize-boilerplate.git

Enter into the directory

cd express-sequelize-boilerplate/

Install the dependencies

yarn

Set the environment variables

cp .env.example .env

Running the boilerplate:

yarn dev

Configuration

Variables for the environment

Option	Description
SERVER_PORT	Port the server will run on
NODE_ENV	development or production
SERVER_JWT	true or false
SERVER_JWT_SECRET	JWT secret
SERVER_JWT_TIMEOUT	JWT duration time
DB_DIALECT	"mysql", "postgresql", among others
DB_HOST	Database host
DB_USER	Database username
DB_PASS	Database password
DB_NAME	Database name
AWS_KEYID	Access key ID
AWS_SECRETKEY	User secret key
AWS_BUCKET	Bucket name

Commands for sequelize

# Creates the database
yarn sequelize db:create 

# Drops the database
yarn sequelize db:drop 

# Load migrations
yarn sequelize db:migrate 

# Undo migrations
yarn sequelize db:migrate:undo:all 

# Load seeders
yarn sequelize db:seed:all

Contributing

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

License

MIT

☕ Code and Coffee