This guide helps contributors fix local setup problems before they start working on Find. It is intentionally focused on beginner environment issues.
For real model, caption, OCR, embedding, or search-quality debugging, use:
Install pnpm:
npm install -g pnpmVerify installation:
pnpm -vFind expects Node.js 18 or newer for the frontend.
Check your installed version:
node -vIf needed, install/update Node.js from:
Install uv from the official installer:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"Verify installation:
uv --versionVerify Python version:
python --versionThe project expects Python 3.12+.
Ensure Docker Desktop or Docker Engine is running before starting containers.
Verify Docker status:
docker psStart the stack:
docker compose up --buildOn Linux systems, Docker may require elevated permissions.
Temporary workaround:
sudo docker compose up --buildOptional permanent fix:
sudo usermod -aG docker $USERLog out and log back in after applying the group change.
Common local ports are:
- Frontend:
3000 - Backend API:
8000 - PostgreSQL:
5432 - Redis:
6379 - MinIO API:
9200 - MinIO console:
9201
Check active ports:
netstat -anoStop conflicting services, or change the relevant port values in .env.
Verify running services:
docker compose psRestart containers if needed:
docker compose restartEnsure MinIO containers are running correctly:
docker compose psExpected ports:
- MinIO API:
9200 - MinIO Console:
9201
Use the light Docker stack for routine contributor work:
docker compose -f docker-compose.light.yml up --build- Use the full stack only when testing real ML inference, captions, OCR, search relevance, or model-loading behavior.
- Review the main README and CONTRIBUTING guide before opening issues or pull requests.