36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# Hermes
|
|
|
|
Hermes is a native iOS and Android prototype for a sports-betting research study.
|
|
The app is designed to feel premium, fast, and clear while keeping the server
|
|
authoritative for timing, odds, settlement, and analytics.
|
|
|
|
## Goals
|
|
|
|
- Native UI on iOS and Android
|
|
- English and Swedish from day one
|
|
- Research-first flow, not real-money betting
|
|
- Structured analytics and audit logging
|
|
- Stable backend and API contracts for iteration
|
|
|
|
## Repo Layout
|
|
|
|
- `backend/` Rust API and migrations
|
|
- `contracts/` OpenAPI and localization contracts
|
|
- `docs/` architecture, schema, and state-machine docs
|
|
- `docs/conventions.md` Rust style notes
|
|
- `infra/` local environment and deployment assets
|
|
- `mobile/` native app scaffolds
|
|
- `fixtures/` sample media and test data
|
|
- `scripts/` helper automation
|
|
|
|
## Coding Conventions
|
|
|
|
- JSON-heavy Rust files should import `serde_json as json`
|
|
- Prefer happy-path functions and early `let Some(...) = ... else { ... }` exits
|
|
|
|
## Status
|
|
|
|
The repository has been initialized with the first planning and backend
|
|
foundation artifacts. The remaining work is to fill out the domain modules and
|
|
native clients.
|