Contributing

Bug reports, doc fixes and pull requests are all welcome.

Development setup

The repo holds two sibling code trees: backend/ (the Django project) and frontend/ (the SvelteKit SPA). Run every Python/Poetry command from backend/.

git clone https://github.com/cinefin/cinefin.git cinefin
cd cinefin/backend
poetry install
poetry run python manage.py migrate
poetry run python manage.py runserver

Build the web interface, and rebuild it after changing anything under frontend/:

cd ../frontend
npm install
npm run build

Checks

Before opening a pull request:

cd backend
poetry run pytest                         # backend tests
poetry run ruff check cinefin/            # lint
poetry run ruff format --check cinefin/   # format
cd ../frontend && npm run check           # frontend type check

These docs

The docs are built with MkDocs Material:

pip install -r requirements.txt
mkdocs serve

Edit the Markdown under docs/ and preview at http://127.0.0.1:8000/.