dev: update dev script for auto-download
All checks were successful
pipeline / lint-and-format (push) Successful in 4m16s
pipeline / build-and-push-images (push) Successful in 47s

This commit is contained in:
2026-02-05 14:28:20 +01:00
parent 50bd0d216d
commit 564de90ecb
4 changed files with 100 additions and 35 deletions

View File

@@ -16,6 +16,22 @@ BuildPath is made of four components:
### Getting started
Developing BuildPath requires Docker for a local MongoDB instance, and a NodeJS/npm installation.
Then, for the first-time setup:
```bash
# Install npm and node
sudo apt install npm nodejs # Ubuntu
sudo pacman -S npm nodejs # Arch
sudo dnf install nodejs # Fedora
# Install docker. Follow instructions on
# https://docs.docker.com/engine/install/
# .. and don't forget docker compose
cd dev && npm i && cd .. # Install dependencies for the dev environment
cd frontend && npm i && cd .. # Install dependencies for frontend
cd match_collector && npm i && cd .. # Install dependencies for match_collector
cd patch_detector && npm i && cd .. # Install dependencies for patch_detector
```
BuildPath needs data to work, either for generating statistics in the `match_collector` or for the frontend.