https://github.com/csdev19/nest-gha
Nest project to test Github Action
https://github.com/csdev19/nest-gha
Last synced: 2 months ago
JSON representation
Nest project to test Github Action
- Host: GitHub
- URL: https://github.com/csdev19/nest-gha
- Owner: csdev19
- Created: 2022-02-19T03:22:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-19T03:22:37.000Z (over 3 years ago)
- Last Synced: 2025-01-25T23:40:10.318Z (4 months ago)
- Language: TypeScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nest Boilerplate
π₯ Nest boilerplate to create projects as fast as possible π₯
## Features
- [x] [Nestjs performance Fastify](https://docs.nestjs.com/techniques/performance)
- [x] [Swagger](https://swagger.io/)
- [x] [Typeorm](https://typeorm.io/)
- [x] [Docker compose](https://docs.docker.com/engine/reference/commandline/compose/)
- [x] [Eslint](https://eslint.org/)
- [x] [Prettier](https://prettier.io/)
- [x] [Docker](https://www.docker.com/)
- [ ] [Jest](https://jestjs.io/)
## Code standards
- The modules are plural **(module-name.module.ts)**
- The controllers are plural and his path too **(controller-name.controller.ts)**
- The services are plural **(service-name.service.ts)**
- The entities are singular **(entity-name.entity.ts)**
## Actual Folder structure
```
βββ dist/
βββ docker-compose.yml
βββ Dockerfile
βββ nest-cli.json
βββ package.json
βββ package-lock.json
βββ README.md
βββ src/
β βββ app.module.ts
β βββ main.ts
β βββ modules/
β βββ /
β β βββ .module.ts
β β βββ dtos/
β β βββ entities/
β β βββ services/
β β βββ interfaces/
β βββ authentication/
β β βββ authentication.controller.ts
β β βββ authentication.module.ts
β β βββ constants/
β β βββ decorators/
β β βββ dtos/
β β βββ encrypt/
β β βββ guards/
β β βββ services/
β β βββ strategies/
β βββ note
β βββ dtos/
β βββ interfaces/
β βββ note.controller.ts
β βββ note.entity.ts
β βββ note.module.ts
β βββ note.service.ts
βββ test/
β βββ app.e2e-spec.ts
β βββ jest-e2e.json
βββ tsconfig.build.json
βββ tsconfig.json
```
## Module structure
```
βββ /
β βββ .module.ts
β βββ dtos/
β βββ entities/
β βββ services/
β βββ interfaces/
```
## Contributors
- Author - Cristian Sotomayor [@csdev](https://github.com/csdev19)
## Extra
If youy want to use snake-case go to this [package](https://www.npmjs.com/package/typeorm-naming-strategies)
### Docker
There is a `docker-compose.yml` file for starting Docker.
`docker-compose up`
After running the sample, you can stop the Docker container with
`docker-compose down`
```
docker-compose up -d postgres
docker-compose ps
docker-compose down
```
[docker investigation ](https://blog.logrocket.com/docker-volumes-vs-bind-mounts/)
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
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
```
## 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).