Update README.md with links to new online documentation

This commit is contained in:
Roland Geider
2025-03-13 14:10:32 +01:00
parent 7bca3ea008
commit 7728b60aec
2 changed files with 7 additions and 66 deletions

View File

@@ -7,7 +7,7 @@ app written with Flutter, it talks via REST with the main server.
If you want to contribute, hop on the Discord server and say hi!
<p>
<p align="center">
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/01%20-%20dashboard.png" width="200" alt="" />
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/04%20-%20measurements.png" width="200" alt="" />
@@ -26,32 +26,17 @@ height="80">](https://f-droid.org/packages/de.wger.flutter/)
## Development
### 1
Install the [wger server](https://github.com/wger-project/wger), the easiest way
is to start the development docker-compose: <https://github.com/wger-project/docker>
Alternatively, you can use the test server (the db is reset every day):
This is a regular flutter application, so you basically just run `flutter run` in
the root directory of the project, and optionally use the test server to login
(the db is reset daily):
* URL: `https://wger-master.rge.uber.space`
* username: `user`
* password: `flutteruser`
* API key: `31e2ea0322c07b9df583a9b6d1e794f7139e78d4`
### 2
For more information consult the development documentation:
Install Flutter and all its dependencies, and create a new virtual device:
<https://flutter.dev/docs/get-started/install>.
The app currently uses flutter 3.27
### 3
Start the application with ``flutter run`` or use your IDE
(please note that depending on how you run your emulator you will need to change the IP address of
the server)
You can run the tests with the ``flutter test``
<https://wger.readthedocs.io/en/latest/development/mobile_app.html>
## Translation

View File

@@ -1,47 +1,3 @@
# Release process
## 1. Update flutter version
If we use a new version, update the version used by
* Github Actions in `build-release.yml` in this repository
* Fdroid build recipe
in [their repo](https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/de.wger.flutter.yml).
Since this can potentially take some time, it should happen well in advance
## 2. Dry-run release before uploading
* Increase build nr in pubspec.yaml (revert after the dry-run was successful)
* `flutter build appbundle --release`
* `bundle install`
* `bundle update fastlane`
* `bundle exec fastlane android test_configuration` (needs the different keys available)
It might be necessary to repeat these steps if upload_to_play_store returns any errors
such as a missing title or similar.
Also note that if a language was added over the weblate UI, it might be necessary
to set the correct language code:
<https://support.google.com/googleplay/android-developer/answer/9844778?hl=en#zippy=%2Cview-list-of-available-languages>
## 3. Push tags to trigger release
Make sure that the commit that will be tagged was already pushed or didn't change
any dart code, otherwise the automatic linter might push a "correction" commit
and the build step will fail.
Set the vX.Y.Z tag locally, push it and delete it. It will get recreated to X.Y.Z.
by github actions.
`TAG=vX.Y.Z && git tag $TAG && git push origin $TAG && git tag -d $TAG`
## 4. Edit release
If necessary, edit the created release on github
## 5. Merge pull requests
* in the flathub
repo: https://github.com/flathub/de.wger.flutter/compare/master...wger-project:de.wger.flutter:master
* in the fork sync master https://github.com/wger-project/de.wger.flutter
* in the flutter repo: https://github.com/wger-project/flutter/branches
Moved to <https://wger.readthedocs.io/en/latest/development/mobile_app.html>