Deployment and setup
Getting started
Set up a safe first instance.
Before you begin
Each institution operates its own instance; this website does not host athlete accounts. Rafik is suitable for a technically supported, self-hosted evaluation beta using synthetic records. Institution privacy/security approval and operational recovery checks remain necessary before real athlete data.
Choose a setup
For an institution, follow deployment and requirements. For local development, obtain the application repository and use Node.js 22.16 or 24, npm and Docker Compose.
Local development
Run in the application repository:
npm ci
npm run backend:start
npm run web-env
npm run start:api
Leave the API terminal running. In a second terminal at the repository root:
npm run dev
Open http://127.0.0.1:5173. Leave the database empty to exercise first-run setup. Optional npm run seed:local is only for a separate, new, empty local demo database; never seed or reset an institution or database containing records you need.
First institution
Keep the empty instance private until first setup completes. The first completed setup creates the super admin and institution without email verification. Administrators add coaches and athletes with seven-day, single-use invitation links; users choose their passwords.
Continue with administration, roles and coach/athlete workflows.
Source and status
Reviewed on 19 October 2026 against the updated quick start, included in PR #127. Main is the canonical branch; documentation follow-up remains under review until merged.