Nest framework TypeScript starter repository.
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. 😊 Contributions are always welcome 😊
Getting started
# 1. Clone the repository or click on "use this template icon"
npx degit NarHakobyan/awesome-nest-boilerplate my-nest-app
# 2. Enter a newly cloned folder
cd nest-boilerplate
# 4. Create environment variables file
cp .env.example .env
# 3. Install dependencies.
yarn
Checklist
- Change the author name in
LICENSE - Change configuration in
.env - Remove the
.githubfolder which contains the funding info - Cleanup the .README file
and enjoy 😂
Development
# 4. Run development server which is open https://localhost:3000
yarn start:dev
# 5. Read the documentation linked below for "Setup and development"
Build To build the App, run
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 + husky= ❤️
This project includes a docs folder with more details on:
For help, discussion about best practices, or any other conversation that would benefit from being searchable: