OCR service built by students at the Catholic University of Lublin (KUL) for internal use. Features asynchronous task processing, clean architecture, and runtime type safety.
Prerequisites: Python 3.12+, Docker, CUDA capable GPU
# Install dependencies (workspace)
uv sync
# Set up environment
cp services/backend/.env.example services/backend/.env
# Create local storage directory (`storage` by default)
mkdir storage
# Install pre-commit hooks
pre-commit install
# Run tests
uv run pytest
# Run app (from backend)
uv run --project services/backend fastapi dev backend/entrypoints/api.py
- Installation Guide - Detailed setup instructions [TODO]
- Contributing - How to contribute to the project
- Conventional Commits - Commit message conventions
- Architecture - System design and structure
MIT License - see LICENSE file for details.