arximughal / NestJsBoilerPlate

NestJS Boilerplate v10

Getting started

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

# 1. clone the repo
git clone {Repo URL}

# 2. 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 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

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
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