Safvan-tsy / x-nest-boilerplate

NestJS Boilerplate , Typescript 💪, Postgres 🎉, TypeORM 🥳, Biomejs🎭, Vitest❤️‍🔥

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nest Logo

Nestjs is a progressive Node.js framework for building efficient and scalable server-side applications.

Getting started

# 1. Clone the repository or click on "Use this template" button.

# 2. Enter your newly-cloned folder.
cd my-nest-app

# 3. Create Environment variables file.
cp .env.example .env

# 3. Install dependencies. (Make sure pnpm is installed: https://pnpm.io/installation)
pnpm install

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

# 4. Run development server and open http://localhost:3000
# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

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

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

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 biomejs = ❤️‍🔥

Documentation

This project includes a docs folder with more details on:

  1. Setup and development
  2. Architecture
  3. Naming Cheatsheet
  4. Linting & formatting

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss on GitHub

Stay in touch

License

MIT licensed.

About

NestJS Boilerplate , Typescript 💪, Postgres 🎉, TypeORM 🥳, Biomejs🎭, Vitest❤️‍🔥

License:MIT License


Languages

Language:TypeScript 99.6%Language:Dockerfile 0.4%Language:Shell 0.1%