justinzeus/scholarr
1
0
Fork 0
Code Issues 1 Pull requests 18 Projects Releases Packages Wiki Activity Actions
scholarr/README.md
Justin Visser e3f0d63fec Big changes
2026-02-21 17:33:05 +01:00

2.3 KiB
Raw Permalink Blame History

scholarr

Self-hosted scholar tracking with a single app image (API + frontend).

CI Docker Pulls Docker Image

Quick Start

  1. Copy env template:
cp .env.example .env
  1. Set required values in .env:
  • POSTGRES_PASSWORD
  • SESSION_SECRET_KEY
  1. Start stack:
docker compose pull
docker compose up -d

Open:

  • App/API: http://localhost:8000
  • Health: http://localhost:8000/healthz

Documentation

Primary docs live under docs/.

  • Index: docs/README.md
  • Deploy and dev workflow: docs/deploy/quickstart.md
  • Environment reference: docs/reference/environment.md
  • API contract and payload conventions: docs/reference/api_contract.md
  • Architecture and domain boundaries: docs/architecture/domain_boundaries.md
  • Scrape safety runbook: docs/ops/scrape_safety_runbook.md
  • DB backup/restore/integrity runbook: docs/ops/db_runbook.md
  • Migration rollout checklist: docs/ops/migration_checklist.md
  • Frontend theme inventory: docs/frontend/theme_phase0_inventory.md
  • Contributing policy: docs/contributing.md

Docs Site (Docusaurus)

Docusaurus source lives in website/ and consumes markdown from docs/.

Local build:

cd website
npm install
npm run build

GitHub Pages deploy is automated via .github/workflows/docs-pages.yml.

Quality Gates

Backend:

docker compose -f docker-compose.yml -f docker-compose.dev.yml run --rm app uv run pytest tests/unit
docker compose -f docker-compose.yml -f docker-compose.dev.yml run --rm app uv run pytest -m integration

Frontend:

cd frontend
npm install
npm run typecheck
npm run test:run
npm run build

Contract and env checks:

python3 scripts/check_frontend_api_contract.py
python3 scripts/check_env_contract.py
./scripts/check_no_generated_artifacts.sh