Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (86 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

124 lines (86 loc) · 2.45 KB

Contribution guidelines

Prerequisites

Install dependencies

  1. Install npm dependencies for all workspaces :
npm i
  1. Pull images at first and then once in a while :
docker compose pull
  1. Then run the containers :
npm run dev-deps

Stop the containers with this command :

npm run stop-dev-deps

Working on @data-fair/processings/api

The API is a small Express server.
Run a development server (access it at http://localhost:8082/api/) :

npm run dev-api

Working on @data-fair/processings/ui

The UI is a Vue 3 project that uses Vuetify 3.
Run a development server (access it at http://localhost:3039/) :

npm run dev-ui

Working on @data-fair/processings/worker

The worker is a small Node.js process that runs periodically the processings.
Run a development process :

npm run dev-worker

Working on types

Update the types based on schemas :

npm run build-types

Building and running the Docker images

Build the images :

docker build --progress=plain --target=main -t data-fair/processings:dev .
docker build --progress=plain --target=worker -t data-fair/processings/worker:dev .

Running the tests

Run the test suite :

npm run test

All-in-one development

You can run all services at once thanks to Zellij.

First time instructions
  1. Install Rust's Cargo
curl https://sh.rustup.rs -sSf | sh
# choose 1 when prompted
  1. Install Zellij
cargo install --locked zellij
  1. Install NVM
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
# in processings
nvm install

Run the Zellij command :

npm run dev-zellij

Access the running services at https://localhost:5600/

Tips :

  • Use Ctrl + Q to quit Zellij. It'll also stop the containers.
  • Click on a panel, then use Ctrl + C then Esc to stop a terminal and regain access of the panel.
  • The logs of the dev-deps panel are stored on the host in the logs directory.