tepbuphatakim/nodejs-boilerplate

A productive Nodejs, Express, and Sequelize RESTful API open-source boilerplate written in modern Javascript.

Nodejs boilerplate

A productive Nodejs, Express, and Sequelize RESTful API open-source boilerplate written in modern Javascript.

Configuration

Copy .env.example and rename to .env.

cp .env.example .env

Configure Jwt secret key and database. The jwt secret key can be anything include a random string.

.env:

JWT_SECRET_KEY=123

DB_HOST=mariadb
DB_DIALECT=mariadb
DB_NAME=db_name
DB_USERNAME=root
DB_PASSWORD=root

Quick start with Docker

Get the application running.

Running Docker

If you already have Docker & Docker compose, run the docker compose command to get the application running below.

Docker version: 24.0.4, Docker compose version: 1.29.2. (Docker version don't have to be exactly the same but some lower version might not working). Build Docker image and run Docker container.

docker-compose up -d --build

Run the bash in Docker container and execute seed with dump data.

docker exec -it {container_name} /bin/bash
npm run seed:up

Quick start in local

Get the application running in your local with node and npm.

Install Node dependency

Installing dependency via npm.

npm version >= 8, node version >= 18.

npm install

Migrate to create the database tables.

npm run migrate:up

Seed dummy data.

npm run seed:up

Running

Running the application.

npm run start

Running in development mode

Running the application in development mode. This will refresh the app when code change.

npm run dev