CLIST

CLIST aggregates competitive-programming contests and standings from hundreds of judges into one calendar, with per-resource leaderboards, unified coder profiles, and ratings. See docs/project-context.md for the full overview (modern Django app + legacy PHP app).

Prerequisites

• Python 3.10
• Docker (with Docker Compose v2)

Development setup

# 1. Fork on GitHub, then clone your fork (submodules included):
git clone --recursive https://github.com/<your-username>/clist.git
cd clist

# 2. Generate default environment files (press Enter to accept defaults):
python3 ./configure.py

# 3. Build and start the long-running dev container:
docker compose up --build dev

# 4. Open the app:
#    http://localhost:10042/

Going further

Want to…	Read
Run management commands, get a Django shell	docs/development-environment.md
Find where something lives / what's risky to touch	docs/repository-map.md
Run tests, lint, format	docs/testing.md, docs/linting-formatting.md
Add or fix a judge parser	docs/parsers.md + the add-parser skill
Change the DB schema	docs/migrations.md + the safe-migration skill
Understand the production stack	docs/infrastructure.md

For repeated local test runs, preserve the migrated test database:

docker compose exec dev ./manage.py test --keepdb

The first run creates and migrates the test database; later runs reuse it and apply only new migrations. See docs/testing.md for narrower test commands.

AI coding agents start in AGENTS.md — the short operating contract that links into the same docs/ tree.

Contributing

1. Branch off master: git checkout -b my-new-feature
2. Commit, push, and open a Pull Request.

For the detailed git policy and safety rules, see docs/git-and-safety.md.