ᐸRepository descriptionᐳ
Monorepo structure is described in root package.json and contains the following packages:
- app - executable service
- client - service client
- dtos - common dtos between service and its client
- dtosTesting - dtos factories for unit tests
- entities - entities
- migrator - service migrator
Make sure you have installed all of the following prerequisites on your development machine:
Some code conventions are enforced automatically by ESLint + Prettier + markdownlint + husky + lint-staged stack.
- Implement business logic
- Add or adapt unit-tests (prefer before and simultaneously with coding)
- Add or change the documentation as needed
- Open pull request in the correct branch. Target the project's
masterbranch
Service can be run locally using the following command:
yarn install
yarn run build
yarn run startThis repository is released under version 2.0 of the Apache License.