Files
sepot/app/README.md
T
Julius Joska 8081d98c67 Šepot — end-to-end encrypted messenger
Initial public release. Anonymous on-device identity (no phone number,
e-mail, or password), Signal-protocol cryptography (X3DH + PQXDH, Double
Ratchet, sealed sender) via libsignal, a metadata-minimizing relay,
group chats, disappearing messages, encrypted local storage, optional
Tor transport, and a UI localized into Czech, English, German, Russian,
and Italian.

Monorepo: Flutter client (app/), Rust relay + wire types (rust/),
protobuf definitions (proto/), self-host deploy (deploy/).

Licensed under AGPL-3.0 with an app-store distribution exception (§7).
2026-07-11 17:21:47 +02:00

29 lines
1008 B
Markdown

# Šepot — Flutter client
The Šepot mobile client. See the [repository README](../README.md) for the
project overview, threat model, and license.
## Quick start
```bash
flutter pub get
flutter run # against the default relay
flutter build apk --release # signed release APK (see key.properties)
```
## Layout
| Path | Contents |
|---|---|
| `lib/core/` | Crypto facade, storage (SQLCipher), relay client + transport, push, services |
| `lib/features/` | Screens (onboarding, chat, contacts, groups, settings, safety…) |
| `lib/models/` `lib/providers/` | Data models and Riverpod providers |
| `lib/l10n/` | Localization (`app_*.arb`, generated `AppLocalizations`) |
| `test/` `integration_test/` | Unit, storage, crypto, and on-device integration tests |
## Localization
Strings are defined in `lib/l10n/app_cs.arb` (template) and translated into
`app_en/de/ru/it.arb`. After editing, run `flutter gen-l10n`. See the root
README for how to contribute a new language.