README.md

A Nest.js boilerplate by TFD for building scalable API.

Scalable NestJS v8 Boilerplate

Features

This is a NestJS boilerplate code with preconfigured libraries and packages with the following features:

• One-click setup with Docker
• Typeorm for Object–relational mapping, use Postgres DB by default
• Sample data generation with typeorm-fixture (generate fixture based on .yaml file), visit RobinCK/typeorm-fixtures.
• Preconfigured Caching Mechanism (Redis Store)
• Swagger UI (Express)
• Authentication with JWT
• Basic RBAC implementation ( You'll have to attach user object to your request manually )
• Basic request time logger

Setup Guide

Be aware that putting DB_SYNC to true in your production may result in irreversible data lost. DB_SYNC should only be put to true in development to skip the necessity of doing migrations.

Without Docker

• Create .env file with command cp .env.example .env and replace with your own env variable
• yarn install
• yarn start (Your API will be exposed through port 3000)

With Docker

Run the following scripts for UNIX (Mac,Linux)

$ cp .env.example .env
$ docker-compose up -d

DOS(Windows)

$ copy .env.example .env
$ docker-compose up -d

Available Services with Docker Container

Once you managed to run the docker container, the following service will be available:

• Nginx will serve as a reverse proxy and will be exposed through port 80 (http://localhost)
• Swagger API Docs (http://localhost/api/docs/)
• Database (Postgres 12) (http://localhost:5432)
• Redis Store (Only Available in internal docker network) (http://0.0.0.0:6379)
• NestJs Server (Only Available in internal docker network) (http://0.0.0.0:3000)

Migration Guide

New migration with typeorm-cli:

$ docker exec -it tfd-nest yarn migration:create -n {CreateTable}

Migration file will be inside src/migrations. Note that you will have to write migration code inside up and down method on your own. To generate migration for new database or from the changes in database schema(entities) use:

$ docker exec -it tfd-nest yarn migration:generate -n {GenerateTable}

Run Migrations

$ docker exec -it tfd-nest yarn migration:run

Revert Migrations

$ docker exec -it tfd-nest yarn migration:revert

Generate Fixture

Fixture lets you play around with sample data. It's not recommended generating in production since it may erase real data. visit RobinCK/typeorm-fixtures for more info.

Generate Sample Data

Make sure the docker container is running

$ docker exec -it tfd-nest yarn fixture:generate

Donation

Kindly donate to the following bank account (Cambodia) if you want to support our works.

KHEANG KIM ANG

001 821 043

You can also donate with Visa Direct.

4026 4503 2163 1102