Environment

• Linux (Ubuntu 22.04 or newer)
• Docker
• docker compose
• Node 20
• yarn

Installation

In bash console:

# Start docker service
$ sudo service docker start

# Run installation script
$ yarn run env:install

Running the application

# Start project in selected mode
# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Useful commands

# Prepare environment
$ yarn run env:local:start

# Stop environment
$ yarn run env:local:stop

# Run migrations
$ yarn run typeorm:run

# Revert migrations
$ yarn run typeorm:revert

# Generate migration
$ yarn run typeorm:generate <migration-name>

# Lint code
$ yarn run format && yarn run lint

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Related Docs

• Architecture
• Auth
• Query
• Tasks

IDEA

Auction/Marketplace

In progress

• Main application flow modules (Auth, Core Logic, Payments, ...)
• Swagger
• Message Bus

Tech Debt

• Application Configuration Service
• Db migration config
• Delete obselete or unnecessary npm packages