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
.githubfolder which contains the funding info - Clean up the README.md file
And, enjoy :)
Scripts
# 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.
We are excited to announce that this project now supports Deno! You can use Deno to run, build, and test your application. 🦕
Scripts
Here are the available scripts for Deno:
# Start the development server
deno task start
# Start the server with file watcher
deno task watch
# Run tests
deno task test
# Compile the application (not working yet)
deno task compile
To build the App using Deno, run:
deno task buildr
And you will see the generated file in dist that is ready to be served.
We are excited to announce that this project now supports Bun! You can use Bun to run, build, and test your application. 🧅
Scripts
Here are the available scripts for Bun:
# Start the development server
bun start:dev:bun
# Start the server with file watcher
bun watch:bun
# Run tests
bun test
# Build the application
bun build:bun
And you will see the generated file in dist that is ready to be served.
Features
Documentation
This project includes a docs folder with more details on:
Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable: