0 Fork 0

mirror of https://github.com/Dvorinka/Containr.git synced 2026-10-28 15:51:26 +00:00

Files

T

Tomas Dvorak aef9eeeff8 docs: verify phase 0 gate, record desloppify rerun

- CONTRIBUTING.md gains a boot smoke test (live/health/401 checks) and a
  cmd/migrate verification recipe.
- desloppify rerun (ref/ excluded): objective 66.1, strict 16.5 under the
  new scoring model — the subjective review queue (20 items) is unscored,
  so strict is not comparable to the February 89.1.

Authored By: TDvorak <[email protected]>

2026-09-17 09:43:55 +02:00

2.2 KiB

Raw Blame History

Contributing to Containr

Thanks for your interest in contributing. Containr is a self-hosted deployment platform — contributions of all sizes are welcome.

Project Layout

app/backend/    Go control-plane API (Gin, PostgreSQL, Redis, Docker SDK)
app/frontend/   React + Vite + TypeScript dashboard
infra/          Self-hosted compose stack (Traefik, Cloudflare Tunnel)
docs/           Guides, API spec, and design documents
templates/      Service template catalog notes

Development Setup

Copy .env.example to .env and fill in values (never commit .env).
Start Postgres and Redis: docker compose up -d postgres redis
Backend: cd app/backend && go run ./cmd/server
Frontend: cd app/frontend && npm install && npm run dev

Checks Before Submitting

Backend: cd app/backend && go build ./... && go test ./... && go vet ./...
Frontend: cd app/frontend && npm run build && npm test
Compose: docker compose config -q

Boot Smoke Test

Verify the API actually starts and serves against real dependencies:

# Requires Postgres + Redis reachable; migrations run automatically on boot.
cd app/backend
DATABASE_URL="postgres://user:pass@localhost:5432/containr?sslmode=disable" \
REDIS_URL="redis://localhost:6379" \
go run ./cmd/server &

curl -fsS http://localhost:8080/live      # -> 200
curl -fsS http://localhost:8080/health    # -> {"database":"ok","redis":"ok",...}
curl -s http://localhost:8080/api/v1/services/x   # -> 401 (auth required, route exists)

kill %1

To verify migrations alone against a scratch database:

cd app/backend
DATABASE_URL="postgres://user:pass@localhost:5432/scratch?sslmode=disable" \
  go run ./cmd/migrate up
DATABASE_URL=... go run ./cmd/migrate goose-status

Conventions

Reuse existing utilities before adding dependencies.
Keep handlers thin; business logic lives in internal/ packages.
Regenerate API types after schema changes: npm --prefix app/frontend run generate:api.
Never commit secrets, tokens, or environment files.
Write tests for non-trivial logic.

Pull Requests

Keep PRs focused — one concern per PR.
Describe the "why", not just the "what".
Include a test plan for anything touching deployment, auth, or networking.

2.2 KiB Raw Blame History