Node Leap is a node boilerplate that follows best practicles of software design and agile
- Docker and Docker compose
- Factory
- Adapter
- Composite
- Decorator
- Dependency Injection
- TDD
- Clean Code
- Clean Archictecture
- Express
- Prisma
- Jest
(nano | vi | vim| nvim ) .env
Create .env follow the .env.example
npm ci
Install js dependencies
npm run start:dev
Access http://localhost:{ENV.PORT} to see the swagger documentation
sudo docker-compose -f docker-compose.dev.yml build && sudo docker-compose -f docker-compose.dev.yml up -d && sudo docker-compose -f docker-compose.dev.yml logs -f
Run the docker to up the adminer, api and databases
Access http://localhost:{ENV.PORT} to see the swagger documentation
npm run plop
To select plop script to run
Select the first option and type the Entity name (ex: TesteRatinho, Batata)
npm run prisma:migration 'Create {name of Entity}'
To create a migration and update the prisma client
Add your entity paths to
/src/infra/swagger/index.ts
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
TODO: describe cloud stack and deploy procedures
Made with ❤️ by Loomi