Skip to content

GitPulse

Documentation was re-verified against the implementation on 2026-05-17.

Teachers

Dashboard usage, metric interpretation, pilot evaluation.

Teacher guide

Developers

Local setup, architecture, quality gates.

Developer guide

Operators

Deployment, monitoring, backup, troubleshooting.

Operator guide

API

Current endpoint contract, authentication, call examples.

API reference

Students

Getting started, understanding metrics, FAQ for students.

Student guide

Privacy statement, terms of service.

Legal information


What the system does

GitPulse automates evaluation of team collaboration in GitLab projects:

  • real-time webhook ingestion
  • compliance rule scoring (R01-R13)
  • rubric-based grading
  • gaming pattern detection
  • dashboard with exports
flowchart LR
    GL["GitLab"] -->|"webhook + API + OAuth"| Caddy["Caddy"]
    Caddy --> API["FastAPI API + Dashboard"]
    Caddy -->|/docs/| Docs["MkDocs\n(nginx)"]
    API --> PG[("PostgreSQL")]
    API --> Redis[("Redis")]
    Redis --> W["RQ Worker ×4"]
    S["rq-scheduler"] --> Redis
    W --> PG
    W --> GL

Operational Snapshot

Area Current state
Architecture FastAPI + PostgreSQL + Redis + RQ + Caddy + MkDocs
Endpoints 174+ route handlers
Monitoring Prometheus + Grafana + Jaeger (monitoring profile)
Authentication GitLab OAuth, __Host- cookie prefix, UA fingerprint, CSRF (HMAC-SHA256)
Documentation Slovak + English, /docs/ (MkDocs Material)

  1. Student: Getting started
  2. Teacher: Getting started
  3. Developer: Local environment
  4. Operator: Deployment
  5. Integration: GitLab tokens and Webhooks

Audit and Transparency

  • Full system scan report: docs/00_system_audit_2026-02-15.md
  • Detailed API specification: docs/04-api-spec.md
  • Observability baseline: docs/13_observability.md