Getting started

Quick installation

Install TraDoc from the repository and start the frontend with the backend.

Windows PowerShell

git clone https://github.com/lucas-lepajollec/tradoc.git
Set-Location tradoc
Copy-Item .env.example .env
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
npm --prefix web ci
.\.venv\Scripts\python.exe main.py dev

Open http://127.0.0.1:2499.

macOS or Linux

git clone https://github.com/lucas-lepajollec/tradoc.git
cd tradoc
cp .env.example .env
python3 -m venv .venv
./.venv/bin/python -m pip install -r requirements.txt
npm --prefix web ci
./.venv/bin/python main.py dev

The dev command supervises Vite and FastAPI. Ctrl+C should stop only those two processes.

Next step

Open Settings → Providers & Models, configure a provider, then run Test connection. Read Providers for details about local and remote services.