Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (48 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.51 KB

Contribution guidelines

Prerequisites

Install dependencies

  1. Install npm dependencies for all workspaces :
npm i
  1. Build / Update the types based on schemas :
npm run build-types

Start the development environment

npm run dev-zellij

Note : This command will start a Zellij session with multiple panes, each one running a part of the project. You can also run the environment manually by running the commands below in different terminals.

Services
  • Dev dependencies : npm run dev-deps
  • UI : npm run dev-ui
  • API : npm run dev-api
  • Daemon : npm run dev-daemon

Stop the development environment

npm run stop-dev-deps

Building the Docker images

docker build --progress=plain --target=main -t data-fair/metrics:dev .
docker build --progress=plain --target=daemon -t data-fair/metrics/daemon:dev .

Running the tests

First, you need to start the development dependencies:

npm run dev-deps

Then, you can run the tests:

npm run test

To run a specific test, you can mark it with it.only or describe.only in the test file, then run the tests with:

npm run test-only test-it/file-name.ts