Skip to content

Latest commit

 

History

History
144 lines (95 loc) · 7.15 KB

README.md

File metadata and controls

144 lines (95 loc) · 7.15 KB
Raw

AgoraDesk, LocalMonero Apps

There are two apps under one code base in this repository.

AgoraDesk

LocalMonero

App Features 🔥

  1. Within one code base there are 2 apps: AgoraDesk, LocalMonero. Each app can be built as Android and iOS native app. Design and logic separation made with flavors (more info further in this doc).

  2. Universal Links work for Android and iOS. In case the app is installed on the device, the regular links will run apps instead of browsers. In case of two apps installed on one device the AgoraDesk app is prioritized (it means in case of link localmonero/something AgoraDesk app will be opened).

  3. Push notifications to work on iOS & Android. In case the user's device (for example in China or with GrapheneOS) can't receive pushes, the app detects it and start polling in the background mode. More info

  4. For privacy, all notifications are sent without translations and are translated on the client-side using data messages in the app code, not through Firebase Cloud Messaging (FCM).

  5. The feature to use a custom proxy (HTTP, SOCKS4, or SOCKS5) has been added in the settings for more secure connections.

  6. Made with Dart & Flutter ❤️

Build

For build the app locally after getting code from repository use FOSS commands in Makefile.

For example, to build a FOSS apk LocalMonero app

flutter build apk --verbose --flavor localmonero --dart-define=app.flavor=localmonero --dart-define=app.includeFcm=false

The apps use MapBox for reverse geocoding. In order to build it yourself, you need to create/provide your own MapBox API key. The instructions can be found here.

After that, create the file lib/keys/keys.dart and add your key there: key const keysMapToken = 'YOUR_MAPBOX_KEY';

You will get the app that works without FCM services. Push notifications will be received with polling with foreground service (if the app is closed it still works).

Flavors

How to build iOS with run parameters

Fastlane

iOS https://docs.fastlane.tools/actions/deliver/

fastlane deliver --skip-screenshots=true

Android https://docs.fastlane.tools/actions/supply/

fastlane supply --skip_upload_changelogs=true --track=internal --skip_upload_screenshots=true

Initial settings

Set up Firebase for different flavors

Set up iOS links for the different apps

ios/Runner/Runner.entitlements ios/Runner/Runner-localmonero.entitlements

Presspacks

Known issues

Push notifications

For privacy reasons, the backend sends push and data messages without translations. We receive them in the app, translate, and then display them. Therefore, our backend doesn't have information about the user's locale.

Contribution

  1. Commits naming https://www.conventionalcommits.org/en/v1.0.0/

Types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.

Mark commit number with #, for example fix: #89.

Also we can use following:

  • feat: A new feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • fix: A bug fix
  • docs: Documentation only changes
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

The source: https://ec.europa.eu/component-library/v1.15.0/eu/docs/conventions/git/#:~:text=feat%3A%20A%20new%20feature,bug%20nor%20adds%20a%20feature

F-Droid

  1. How to publish Flutter app on F-Droid - https://localmonero.co/devblog/publish-flutter-app-fdroid
  2. As we use Flutter as submodule, we should update it with F-Droid releases git submodule update --rebase --remote

Credits

  • We thank shortwavesurfer2009 for extensive accessibility testing