Development setup — CookieFarm

This page defines the recommended local development setup for CookieFarm.

Required versions

git --version
go version
python3 --version
bun --version
docker --version
docker compose version

git clone https://github.com/ByteTheCookies/CookieFarm.git
cd CookieFarm

cd cookiefarm/server
go mod download
go build ./...
go test ./... -v

Run server locally:

go run .

cd cookiefarm/client
go mod download
go build ./...
go test ./... -v

cd exploiter/python
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -e .

Optional tests:

pytest -q

cd docs
bun install
bun run dev

Type check/build:

bun run types:check
bun run build

cd cookiefarm
docker compose up -d --build

Quick API check:

curl -i --max-time 5 http://127.0.0.1:8080/api/v1/

Use Bun for docs/frontend package management and scripts.
Use Bun as the only JavaScript package manager/runtime in this project workflow.
Keep local environment aligned with the versions above before opening PRs.