Nestjs Awesome Boilerplate

Prerequisite

• Nodejs 18 above
• Docker + Docker Compose
• [Yarn] npm i -g yarn

Getting started

# 1. Clone this project
git clone https://github.com/jackgoh/awesome-nest-boilerplate {your project name}

# 2. Enter your newly-cloned folder.
cd your-project-name

# 3. Create Environment variables file.
cp .env.example .env

# 4. Install dependencies. (Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install)
yarn

# 5. Run DB
docker compose up

Development

# 4. Run development server and open http://localhost:3000
yarn watch:dev

# 5. Read the documentation linked below for "Setup and development".

Generate migration

yarn migration:generate ./src/database/migrations/{your migration name}

#Example
yarn migration:generate ./src/database/migrations/add-post-table

Build

To build the App, run

yarn build:prod

And you will see the generated file in dist that ready to be served.

Documentation

This project includes a docs folder with more details on:

1. Setup and development
2. Architecture
3. Naming Cheatsheet