@@ -34,6 +34,8 @@ A simple, efficient and cross-platform workout logging application with
3434- 📊 Track your progress over time on several metrics and exercises in analytics
3535- 📱 Responsive design, ergonomic navigation, local-first, performant
3636
37+ ![ home] ( .screenshot/home.png )   ; ![ search] ( .screenshot/search.png )   ; ![ analytics] ( .screenshot/analytics.png )
38+
3739## Project Structure
3840
3941The project follows a modular [ Rust] structure for a [ Dioxus] application:
@@ -102,11 +104,11 @@ LogOut/
102104The project uses [ Nix] to download all (proper versions of) required
103105dependencies, configure the development environment (shell) and build the
104106application, reproducibly. The [ Nix] environment and tooling is defined in
105- [ ` flake.nix ` ] ( ./ flake.nix) , enable it with ` nix develop ` or automatically with
106- an allowed [ ` .envrc ` ] ( ./ .envrc) and [ ` direnv ` ] (recommended):
107+ [ ` flake.nix ` ] ( flake.nix ) , enable it with ` nix develop ` or automatically with an
108+ allowed [ ` .envrc ` ] ( .envrc ) and [ ` direnv ` ] (recommended):
107109
108110For release builds, we prefer pure reproducible ` nix build ` , but for development
109- speed, it is recommended to use the hot-reloading ` dx serve ` .
111+ speed, it is recommended to use the hot-reloading ` dx serve ` ( [ PWA ] by default) .
110112
111113### Android Native APK
112114
@@ -215,7 +217,7 @@ Follow this contribution process, based on [GitHub Flow], [Conventional Branch]:
215217pass through a pull-request (PR), and every below check (that runs on pushes on
216218PRs) must pass (for some, at a certain level) for it to be merged into ` main ` .
217219
218- - Run isolated in Garnix via (` flake.nix ` )[ ./ flake.nix] , for every push on PR
220+ - Run isolated in Garnix via (` flake.nix ` )[ flake.nix] , for every push on PR
219221 - Check if the code is properly ** formated** ` cargo fmt --all -- --check `
220222 - ** Lint** ` cargo clippy -- -D warnings -W clippy::all -W clippy::pedantic `
221223 - ** Unit test** while measuring ** coverage** with ` cargo llvm-cov `
@@ -277,6 +279,7 @@ checks that run every Sunday at midnight on the `main` branch.
277279[ llvm-cov ] : https://llvm.org/docs/CommandGuide/llvm-cov.html
278280[ Maestro ] : https://maestro.dev
279281[ Nix ] : https://nixos.org
282+ [ pwa ] : https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps
280283[ rust-analyzer ] : https://rust-analyzer.github.io
281284[ rust ] : https://www.rust-lang.org
282285[ rustc ] : https://doc.rust-lang.org/rustc
0 commit comments