Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,27 +68,30 @@ Required test coverage of 75.0% reached. Total coverage: 98.64%

### CI on a sample PR

Eight backend + two frontend + four security jobs all green on every PR:
Ten jobs across `ci.yml` (eight backend + two frontend) — all green:

![CI status](docs/images/ci-green.png)

> **Capture:** open <https://github.com/constk/harness-python-react/actions/workflows/ci.yml>, click any green run on `develop`, screenshot the job-list panel. Save as `docs/images/ci-green.png`.
The four security-workflow jobs (gitleaks, pip-audit, npm audit, trivy) gate every PR alongside this set; see the [Security workflow runs](https://github.com/constk/harness-python-react/actions/workflows/security.yml).

### Hello page (`docker compose up`)
### Hello page (`npm run dev` / `docker compose up`)

The scaffold's React page hits `/api/v1/health` on load and renders the version + status badge:
The scaffold's React page hits `/api/v1/health` on load and renders the version + status badge. The Vite dev server proxies `/api/*` to the FastAPI backend (target overridable via `VITE_API_PROXY_TARGET`):

![Hello page](docs/images/hello-page.png)

> **Capture:** `docker compose up`, open <http://localhost:5173>, screenshot.
<!--
TODO (#28): one capture left — Jaeger trace.

### Jaeger trace for `/api/v1/health`
docs/images/jaeger-trace.png
With the full stack running (`docker compose up`), hit /api/v1/health
once, then open http://localhost:16686, select service
`harness-python-react`, click the most recent trace, screenshot the
span timeline.

OTel auto-instrumentation produces one span per request, exported via OTLP gRPC to the local Jaeger:

![Jaeger trace](docs/images/jaeger-trace.png)

> **Capture:** with the stack running, hit `/api/v1/health` once, then open <http://localhost:16686>, select service `harness-python-react`, click the most recent trace, screenshot the span timeline.
When the PNG lands in docs/images/, replace this comment with a section
analogous to "Hello page" above.
-->

## Why a harness

Expand Down
Binary file added docs/images/ci-green.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hello-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading