https://github.com/liliwei25/nestjs-template

NestJS template with everything you need to get started
https://github.com/liliwei25/nestjs-template

commitlint cors eslint helmet husky lint-staged nestjs prettier swc template typescript

Last synced: about 1 month ago
JSON representation

NestJS template with everything you need to get started

• Host: GitHub
• URL: https://github.com/liliwei25/nestjs-template
• Owner: liliwei25
• License: mit
• Created: 2024-09-07T16:47:00.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T17:12:24.000Z (2 months ago)
• Last Synced: 2024-09-29T16:40:54.986Z (about 2 months ago)
• Topics: commitlint, cors, eslint, helmet, husky, lint-staged, nestjs, prettier, swc, template, typescript
• Language: TypeScript
• Homepage:
• Size: 234 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![main test workflow status](https://github.com/liliwei25/nestjs-template/actions/workflows/main-test.yml/badge.svg)

## Description

NestJS template with everything you need to get started

1. Uses [commitlint](https://github.com/conventional-changelog/commitlint) to keep commits clean and tidy

2. Uses [eslint](https://eslint.org/), [prettier](https://prettier.io/), [husky](https://typicode.github.io/husky/) and [lint-staged](https://github.com/lint-staged/lint-staged) to automatically format code

3. Uses [swc](https://swc.rs/) for speedy compilation

4. Uses TypeScript with [strict mode](https://www.typescriptlang.org/tsconfig/#strict) for improved code correctness

5. Enabled [helmet](https://github.com/helmetjs/helmet) and [cors](https://expressjs.com/en/resources/middleware/cors.html) for basic security

6. Uses [bun](https://bun.sh/)

7. Uses [zod](https://github.com/colinhacks/zod) for schema validation

8. Uses [Docker](https://www.docker.com/) for containerization

9. Uses [Github Actions](https://github.com/features/actions) for workflows

## Project setup

```bash

$ bun install

```

## Compile and run the project

```bash

# development

$ bun run start

# watch mode

$ bun run start:dev

# production mode

$ bun run start:prod

```

## Run tests

```bash

# unit tests

$ bun run test

# e2e tests

$ bun run test:e2e

# test coverage

$ bun run test:cov

```

##

## License

This is [MIT licensed](https://github.com/liliwei25/nestjs-template/blob/main/LICENSE).