A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Project Structure
```
.
└── [app-name]
├── .husky <-- support git hooks (auto format before commit & run test before push)
├── src <-- business logic
│ ├── common <-- common module
│ ├── shared <-- shared decorator/exception/guards/....
│ ├── [your-module1] <-- sample to put your module 1
│ ├── [your-module2] <-- sample to put your module 2
│ ├── app.config.ts <-- centralize app config
│ ├── app.controller.spec.ts <-- test spec for app controller
│ ├── app.controller.ts <-- app controller (like as core controller)
│ ├── app.module.ts <-- app module (like as core module)
│ ├── app.service.ts <-- app service (like as core service)
│ └── main.ts <-- nestjs main file
├── test <-- e2e test put here
│ ├── app.e2e-spec.ts <-- e2e test for app module
│ └── jest-e2e.json <-- jest config e2e
├── .editorconfig <-- general config for most of editor
├── docker-compose.yml <-- docker compose for Dev env
├── Dockerfile <-- Dockerfile for build image (use to deploy to staging/beta/production)
├── ...
└── README.md
```
#### Explanation
1. `.husky` - keep the default project githooks (pre-commit - auto format code, pre-push - make sure by pass test before push to remote)
2. `[your-module1]` - created by command `yo nestjs-service:module your-module1` run in nestjs root directory - see more at https://github.com/datpp/generator-nestjs-service (module generator)
3. `app.config.ts` - all config of the app should be put here to help you easy control the configuration for each environment
4. `docker-compose.yml` - support for the developer quick setup local environment
5. `Dockerfile` - support CI/CD build image
<% if (useMongoose) { %>
#### Database Accessing
- For mongodb express you can access at http://localhost:8081 (make sure run `docker-compose up` first)
<% } %>
<% if (useKafka) { %>
#### Kafka
- Access Kafka Manager via http://localhost:9000 (make sure run `docker-compose up` first)
- Add a cluster with Zookeeper host is `zookeeper:2128`, for other field leave default
<% } %>
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).
