> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nilbenchmarks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NIL Benchmark Platform

> A data platform for universities to report, track, and benchmark NIL deals across their athletic departments.

## What is NIL Benchmark?

NIL Benchmark is a full-stack platform that allows universities to securely report NIL deals involving their athletes, track budgets per sport, verify compliance, and benchmark anonymized data against conference and peer institutions.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get the platform running locally in under 5 minutes.
  </Card>

  <Card title="Architecture" icon="sitemap" href="/architecture">
    System design, tech stack, and how all the pieces connect.
  </Card>

  <Card title="Database Schema" icon="database" href="/database/schema">
    Full breakdown of all 15 tables and relationships.
  </Card>

  <Card title="API Reference" icon="code" href="/api/auth">
    55 REST endpoints across 11 resource groups.
  </Card>
</CardGroup>

## Core Capabilities

* **NIL Deal Submission** — Upload contracts (PDF/DOCX), AI extracts fields automatically, user reviews and confirms
* **Athlete Management** — Full roster with deal history, eligibility tracking, compliance checklists
* **Budget Tracking** — Per-sport annual caps with real-time utilization bars and over-budget alerts
* **Benchmarking** (Premium) — Compare your school vs conference vs custom peer groups with percentile rankings
* **Compliance Reporting** — Verification queue, policy checks, audit log, expiring deal alerts
* **Role-Based Access** — Admin, Agreement Manager, Read Only roles with Standard/Premium tier gating

## Tech Stack

| Layer      | Technology              | Purpose                                    |
| ---------- | ----------------------- | ------------------------------------------ |
| Frontend   | Vue 3, TypeScript, Vite | SPA with Composition API                   |
| UI         | Tailwind CSS 3          | Custom design system (navy/gold/sky)       |
| State      | Pinia + TanStack Query  | Auth state + server data cache             |
| Backend    | Python 3.12, FastAPI    | Async REST API with auto OpenAPI docs      |
| ORM        | SQLAlchemy 2.0          | Async PostgreSQL via asyncpg               |
| Database   | PostgreSQL 16           | JSONB, window functions, `percentile_cont` |
| Storage    | MinIO (S3-compatible)   | Contract PDF storage with presigned URLs   |
| Auth       | JWT + bcrypt            | Access/refresh tokens, RBAC + tier gating  |
| Extraction | pdfplumber + regex NLP  | Real PDF text parsing — no external API    |
| Infra      | Docker Compose          | 4 services, single `docker compose up`     |

## Demo Accounts

| Email                         | Password      | Role              | Tier     |
| ----------------------------- | ------------- | ----------------- | -------- |
| `admin@bluemountain.edu`      | `password123` | Admin             | Premium  |
| `sarah.chen@bluemountain.edu` | `password123` | Agreement Manager | Premium  |
| `mike.t@bluemountain.edu`     | `password123` | Agreement Manager | Standard |
| `coach.w@bluemountain.edu`    | `password123` | Read Only         | Standard |

## Seeded Demo Data

The database ships with **2,320 athletes**, **1,852 deals**, **17 universities** across **10 real conferences** (SEC, ACC, Big Ten, etc.) with realistic value distributions by sport and position (Football QBs $50K-$500K, other positions scaled accordingly). Budget allocations, activity logs, athlete notes, and contract files in MinIO are all pre-populated.