This template includes a development setup and environment multi OS support ready-to-use outside the box, and has the config ready for:
- ESLint
- Prettier integration
- Docker hot reload feature (Windows supported)
- Husky integration
- Commit lint (Conventional commits standard)
- Joi .env validation schema
Before using this template, ensure you have Node.js installed (version 20.12.0 for this template) and Docker installed and running.
1 . Install dependencies using yarn as package manager:
yarn
2 . Replace .env.template variables and rename it as .env file
Variable | Type | Description |
PORT | Integer (positive) | Port where app runs |
3 . Development mode using Docker: Run Docker compose file in the branch directory:
docker-compose -f docker-compose.dev.yml up --build
4 . Development mode without Docker: Start the development server:
yarn start:dev