Jay Brown
6dccf494f8
cleanup permit policies and correct documentation * docs * policy cleanup * refactor * Merge remote-tracking branch 'origin/feature/permit-policy-cleanup' into feature/permit-policy-cleanup * docs and edits
1.7 KiB
1.7 KiB
Getting Started Guide
Prerequisites
- Devbox
- Docker
- Go 1.24.x (provided by devbox)
- Task (
task)
Local Setup
git clone <repository-url>
cd query-orchestration.2
touch .env
devbox shell
Verify Tooling
go version
docker --version
task --version
task --list
Common Tasks
Generate and Build
task generate
task build
Full Test/Validation Suite
task fullsuite
Local Compose Lifecycle
task compose:up
task compose:down
task compose:clean
Linting
task lint
Useful Focused Tasks
task openapi:generate
task db:generate
task db:lint
task test:functional
task test:race
Key Local Ports
queryAPI:8080storeEventRunner:8081docInitRunner:8082docSyncRunner:8083docCleanRunner:8084clientSyncRunner:8089prometheus:9091postgres:5432localstack:4566permit_pdp:7766
Deprecated compatibility services (still present in compose in some environments)
docTextRunner:8085querySyncRunner:8087queryRunner:8088queryVersionSyncRunner:8090
Minimal .env Example
PGUSER=postgres
PGPASSWORD=password
PGDATABASE=queryorchestration
PGHOST=localhost
PGPORT=5432
DB_NOSSL=true
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=test
AWS_SECRET_ACCESS_KEY=test
AWS_SESSION_TOKEN=test
AWS_ENDPOINT_URL=http://localhost:4566
AWS_S3_USE_PATH_STYLE=true
DISABLE_AUTH=true
LOG_LEVEL=DEBUG
BUCKET=<your-bucket-name>
Troubleshooting
# Validate compose files
task compose:lint
# Check migrations/codegen
task db:generate
task openapi:generate
# Recreate local containers/volumes
task compose:clean
task compose:up