iamfive / awesome-nest-boilerplate

Awesome NestJS Boilerplate 😍, Typescript 💪, Postgres 🎉, TypeORM 🥳

Awesome NestJS v7 Boilerplate

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.
git clone https://github.com/NarHakobyan/awesome-nest-boilerplate.git my-new-project

# 2. Enter your newly-cloned folder.
cd my-new-project

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

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

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

Features

Quick scaffolding

Create modules, services, controller - right from the CLI!

Instant feedback

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes are reflected instantaneously.

JWT Authentication

Installed and configured JWT authentication.

Next generation Typescript

Always up to date typescript version.

Industry-standard routing

It's natural to want to add pages (e.g. /about`) to your application, and routing makes this possible.

Environment Configuration

development, staging and production environment configurations

Swagger Api Documentation

Already integrated API documentation. To see all available endpoints visit http://localhost:3000/documentation

Linter

eslint + prettier = ❤️

Documentation

This project includes a docs folder with more details on:

1. Setup and development
2. Architecture