Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NarHakobyan/awesome-nest-boilerplate
Awesome NestJS Boilerplate 😍, Typescript 💪, Postgres 🎉, TypeORM 🥳
https://github.com/NarHakobyan/awesome-nest-boilerplate
List: awesome-nest-boilerplate
Last synced: 3 months ago
JSON representation
Awesome NestJS Boilerplate 😍, Typescript 💪, Postgres 🎉, TypeORM 🥳
- Host: GitHub
- URL: https://github.com/NarHakobyan/awesome-nest-boilerplate
- Owner: NarHakobyan
- License: mit
- Created: 2019-02-27T18:50:30.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T16:40:25.000Z (4 months ago)
- Last Synced: 2024-11-03T10:02:09.398Z (3 months ago)
- Language: TypeScript
- Homepage: https://narhakobyan.github.io/awesome-nest-boilerplate
- Size: 3.86 MB
- Stars: 2,388
- Watchers: 32
- Forks: 451
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nestjs - Awesome Nest Boilerplate 😍
- awesome-boilerplate - Awesome Nest Boilerplate
- awesome-nestjs - Awesome Nest Boilerplate - Typescript, Postgresql, TypeORM, Swagger for Api documentation, Role base access control, and best application architecture. (Resources)
README
# Awesome NestJS Boilerplate v10
[](https://github.com/juliandavidmr/awesome-nestjs)
> This is an ever-evolving, very opinionated architecture and dev environment for new node projects using [NestJS](https://nestjs.com). Questions, feedback, and for now, even bikeshedding are welcome. 😄
## Getting started
```bash
# 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
```bash
# 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
```bash
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](https://narhakobyan.github.io/awesome-nest-boilerplate/docs/development.html#first-time-setup)
1. [Architecture](https://narhakobyan.github.io/awesome-nest-boilerplate/docs/architecture.html)
1. [Naming Cheatsheet](https://narhakobyan.github.io/awesome-nest-boilerplate/docs/naming-cheatsheet.html)
## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
[Discuss Awesome NestJS Boilerplate on GitHub](https://github.com/NarHakobyan/awesome-nest-boilerplate/discussions)