PepiandGitHub
aa0e492581
* feat: add translations for signer related messages * refactor: add constants file with nostr events kinds * refactor: move signer methods to service * refactor: add nsec storage option to use nsec hook * refactor: simplify auth provider for signer related methods * refactor: signout screen with different callout msg depending on nsec storage * refactor: show callout in profile keys screen for signer nsec storage * refactor: rename use login hook to use login with nsec * refactor: rename use android signer hook and make api more similar to the use login with nsec * refactor: use in login screens renamed hooks and improve ux a bit * refactor: remove unused android signer service provider * docs: update docs files * test: switch profile navigation
2.7 KiB
2.7 KiB
White Noise
A secure, private, and decentralized chat app using the marmot protocol 🦫 to build secure messaging with MLS and Nostr
📱 Supported Platforms
- ✅ Android - Fully supported
- ✅ iOS - Fully supported
- ⏳ macOS - Not supported yet
- ⏳ Windows - Not supported yet
- ⏳ Linux - Not supported yet
- ⏳ Web - Not supported yet
Structure
lib/
├── constants/ # Shared constants: fixed, related sets or reused elsewhere only
├── providers/ # Shared state
├── hooks/ # Ephemeral widget state
├── services/ # Stateless operations (API calls)
├── screens/ # Full-page components
├── widgets/ # Reusable components
🏗️ Stack
- Flutter
- Rust
- flutter_rust_bridge - Dart ↔ Rust integration
- whitenoise rust crate 🦀
Prerequisites
- Flutter SDK (3.24.x or later)
- Rust (latest stable)
- Just -
cargo install just - flutter_rust_bridge_codegen -
cargo install flutter_rust_bridge_codegen
🛠️ Commands
# Install dependencies
just deps # Install both Flutter and Rust deps
just deps-flutter # Flutter dependencies only
just deps-rust # Rust dependencies only
# Format code
just format # Format both Rust and Dart
just format-rust # Format Rust only
just format-dart # Format Dart only
# Coverage
just coverage # Checks tests coverage
Coverage Report
You need to install lcov to generate report
# Mac OS
brew install lcov
# Linux
apt-get install lcov
# First run tests with coverage option
flutter test --coverage
# Generate coverage html report
genhtml coverage/lcov.info -o coverage/html
# Open coverage/html/index.html in your browser
Development philosophy
- We keep complexity low.
- We keep the app thin.
- We test our code.
- We delete dead code. Commented code is dead code.
- We use the Whitenoise Rust crate as the source of truth.
- We avoid caching in Flutter; the Whitenoise crate already persists data in a local DB.
- We put shared app state in providers.
- We put ephemeral widget state in hooks.
- We pass data to hooks, not widget refs.
- We let screens watch providers and pass data to hooks.
- We avoid comments unless strictly necessary and write self-explanatory code.