Awesome NestJS Boilerplate v10

This is an ever-evolving, very opinionated architecture and dev environment for new node projects using NestJS. Questions, feedback, and for now, even bikeshedding are welcome. 😄

Getting started

# 1. Clone the repository or click on "Use this template" button.
npx degit NarHakobyan/awesome-nest-boilerplate my-nest-app

# 2. Enter your newly-cloned folder.
cd my-nest-app

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

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

Checklist

When you use this template, try follow the checklist to update your info properly

• Change the author name in LICENSE
• Change configurations in .env
• Remove the .github folder which contains the funding info
• Clean up the README.md file

And, enjoy :)

Development

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

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

Build

To build the App, run

yarn build:prod

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

Features

Documentation

This project includes a docs folder with more details on:

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

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss Awesome NestJS Boilerplate on GitHub