ᐸRepository nameᐳ

ᐸRepository descriptionᐳ

Monorepo

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

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git
• Node.js (version 16 LTS or higher)
• Yarn package manager

Code conventions

Some code conventions are enforced automatically by ESLint + Prettier + markdownlint + husky + lint-staged stack.

Service development lifecycle

• 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 master branch

Running locally

Service can be run locally using the following command:

yarn install
yarn run build
yarn run start

Maintainers

• @Byndyusoft/owners <github.maintain@byndyusoft.com>
• @Byndyusoft/team
• @KillWolfVlad

License

This repository is released under version 2.0 of the Apache License.