Docs

Operator and integrator documentation for humaniser.eu. The site is open-source for transparency; everything here is reproducible on your own machine.

Run it locally

  • RUNBOOK-LOCAL.md — single-command setup (./run-local.sh). See the source on GitHub.
  • ./run-local.sh --check tests prerequisites without installing anything.
  • Logs live in /tmp/humaniser-api.log and /tmp/humaniser-web.log.

API reference

The FastAPI backend self-documents at /docs on the API port (default 8000).

Endpoints: POST /v1/detect, POST /v1/paraphrase, POST /v1/postprocess, POST /v1/humanise, POST /v1/benchmark, GET /v1/healthz.

Research

Legal & compliance

Tests

Playwright suite under apps/web/tests/. Run with:

cd apps/web
pnpm test                       # all suites
pnpm test tests/user-stories.spec.ts  # the full user-story matrix
pnpm test:ui                    # interactive UI mode

The Playwright config auto-starts the Astro dev server but assumes the FastAPI backend is already up on :8000. Run ./run-local.sh api in another shell first.