Skip to content
AlessioBrilloPublic

About

Averyn (codename): open-source, self-hostable sports tracking for iOS, Android and Web. Pre-alpha, AGPL-3.0-or-later.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

213 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Averyn

Codename. The final public name is an open decision (ADR-0008).

An open-source, self-hostable sports platform for iOS, Android and Web: recording, analysis, history and export, with no paywall on core features.

Status: pre-alpha. The MVP-1 code, most of MVP-2 and several MVP-L slices are in place and covered by automated tests. Nothing is verified on a real device yet: the device matrix has 0 of 50 scenarios filled, and a feature is not "done" until its row is green (ADR-0028). The remaining launch work, with owners and estimates, is in mvp-launch.md.

Status at a glance

Area In code Verified on a device Notes
Tracking (Android, iOS) yes, with tests no the device matrix is empty (0/50); emulators are not evidence
Backend, sync, account yes, with tests no Testcontainers integration tests; one Ktor modular monolith
Web app yes, with tests no activity list and detail, map, analysis; there is no admin interface (overview)
Analysis and records yes, with tests no splits, elevation, series, best efforts, heart rate, zones
Imports and export GPX, FIT, archive no TCX is after MVP-L; export and deletion are implemented
Self-hosting yes no Compose stack with PostgreSQL/PostGIS, object storage, Zitadel IdP and the web app
iOS build yes no built on macOS, not covered by CI; see apps/ios

Repository layout

Path Contents
apps/android Jetpack Compose app and the native tracking adapter
apps/ios SwiftUI app and the native tracking adapter (Xcode project generated by XcodeGen)
apps/web React + TypeScript web app
shared/ Kotlin Multiplatform: domain, tracking, metrics, analysis, sensors, sync, api, client, ios-umbrella
backend/ Ktor modular monolith and Flyway migrations
build-logic/ Gradle convention plugins
infrastructure/compose Docker Compose stack for local development and self-hosting
tools/campaign Reads the exported diagnostics and prints a device-matrix row
tests/gps-fixtures/ Reference GPS traces with expected results
docs/ Product, architecture, ADRs, design docs, metrics, privacy, deployment and runbooks — start at docs/README.md

Quickstart (self-hosting)

Requirements: Docker with Compose v2.

cd infrastructure/compose
sh init-env.sh                  # writes .env and the object store keys with random secrets (once)
docker compose --env-file .env up -d --build
curl http://localhost:8080/ready  # {"status":"ready"} once the database is migrated

The stack also starts the identity provider and the web app: open http://localhost:8082 for the web app and http://idp.localhost:8081 for the Zitadel console. The canonical guide, including the TLS overlay for an instance others reach, is docs/deployment/self-hosting.md. infrastructure/compose/.env.example is the manual fallback, not the recommended path.

Development

Requirements: JDK 21, Node 22+ and Docker (for the backend integration tests).

./gradlew check                                              # JVM/KMP tests + ktlint
(cd apps/web && npm ci && npm run check && npm run build)    # oxlint, typecheck, vitest, build

The full local gate is tools/ci/ci-local.sh (Docker required): it copies the working tree to a temp directory and runs the same pipeline as the Woodpecker gate (.woodpecker/ci.yml). iOS is not covered by CI; build it on macOS following apps/ios/README.md.

Releases

There are no tagged releases yet. Self-host from a commit on main; the first tag will be v0.1.0 at MVP-L. The upgrade runbook uses commit ids until then. See CHANGELOG.md.

Contributing

Read CONTRIBUTING.md. Significant decisions go through an ADR; non-trivial features start with a design doc (docs/design). Security issues go through SECURITY.md, never a public issue.

License

AGPL-3.0-or-later. The copyright notice and the "or later" grant are in NOTICE. Rationale in ADR-0002.

About

Averyn (codename): open-source, self-hostable sports tracking for iOS, Android and Web. Pre-alpha, AGPL-3.0-or-later.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages