Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isaquetdiniz/nest-leap
https://github.com/isaquetdiniz/nest-leap
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/isaquetdiniz/nest-leap
- Owner: isaquetdiniz
- License: mit
- Created: 2024-03-05T17:48:34.000Z (8 months ago)
- Default Branch: nest
- Last Pushed: 2024-04-29T12:28:35.000Z (7 months ago)
- Last Synced: 2024-04-29T13:45:08.276Z (7 months ago)
- Language: TypeScript
- Size: 3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[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).
Node Leap
Node Leap is a node boilerplate that follows best practicles of software design and agile
### Userful links
## Requeriments
- Docker and Docker compose
## 💻 Running
### Local
**`(nano | vi | vim| nvim ) .env`**
> Create .env follow the env/.env.local.example
**`npm ci`**
> Install js dependencies
**`npx husky prepare`**
> Add husky scripts
**`sudo docker-compose --profile local up -d`**
> Run docker with profile local
**`npm run start:dev`**
**`npm run start:dev`**
> Access http://localhost:{ENV.PORT} to see the swagger documentation
### Development
**`(nano | vi | vim| nvim ) .env`**
> Create .env follow the env/.env.dev.example
**`sudo docker-compose --profile dev up -d && sudo docker-compose logs -f`**
> Run docker with profile dev
> Access http://localhost:{ENV.PORT} to see the swagger documentation
### Production
**`(nano | vi | vim| nvim ) .env`**
> Create .env follow the env/.env.prod.example
**`sudo docker-compose --profile prod up -d && sudo docker-compose logs -f`**
> Run docker with profile prod
> Access http://localhost:{ENV.PORT} to see the swagger documentation
### Generate new domain for entity
**`npm run plop`**
> To generate files in domains
> Type the entity name (ex: TesteRatinho, Batata, AuthUser)
**`npm run prisma:migration 'add-{name of Entity}-table'`**
> To create a migration and update the prisma client
> Add your entity paths to `/src/main/infra/swagger/index.ts`
> Add your entity routes to `/src/main/infra/express/routes.ts`
## 💻 Testing
### UNIT
> Don't need of the project run to test!
**`npm run test:unit`**
> To run tests in time of development with hot-reload
**`npm run test:ci`**
> To run all tests of the project and generate coverage
## ☁️ Deploying
`TODO: describe cloud stack and deploy procedures`
#
Made with ❤️ by **Loomi**