wger-project/flutter
1
0
Fork 0
mirror of https://github.com/wger-project/flutter.git synced 2026-02-18 00:17:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Corrections of some misspelled words.
This commit is contained in:
Saint Gabriel
2022-06-04 00:52:21 +01:00
committed by GitHub
parent 9830a8e2cb
commit f22ea5592e
1 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -1,7 +1,7 @@
# Mobile app for wger Workout Manager
wger is a free, open source flutter application that manages and tracks/logs
your exercises and personal workouts, weight and diet plans. This is the mobile
wger is a free, open-source flutter application that manages and tracks/logs
your exercises and personal workouts, weight, and diet plans. This is the mobile
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!
@@ -26,13 +26,13 @@ If you want to contribute, hop on the Discord server and say hi!
## Development
### 1
Install the wger server, the easiest way is starting the development docker-compose:
Install the wger server, the easiest way is to start the development docker-compose:
<https://github.com/wger-project/wger>
Alternatively, you can use one of our test servers, just ask us for access.
### 2
Install Flutter, all its dependencies and create a new virtual device:
Install Flutter, and all its dependencies, and create a new virtual device:
<https://flutter.dev/docs/get-started/install>.
The app currently uses flutter 2.10
@@ -45,12 +45,12 @@ WGER_API_KEY=123456
```
To just run/develop the app it only needs to have any value for WGER_API_KEY, but
you need a correct value if you want to register via the app. For this you need
to allow (a probably dedicated) user on the wger server to register users in its
you need a correct value if you want to register via the app. For this, you need
to allow (a probably dedicated) user on the wger server to register users on its
behalf. For this, generate an API KEY by visiting <http://localhost:8000/de/user/api-key>
on your local instance and then run ``python3 manage.py add-user-rest theusername``
on your local instance and then run ``python3 manage.py add-user-rest the username``
You can later list all the registered users with: ``python3 manage.py list-users-api``
You can later list all the registered users with: ``python3 manage.py list-users-API``
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
@@ -58,10 +58,10 @@ You can later list all the registered users with: ``python3 manage.py list-users
### 4
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)
(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``
You can run the tests with ``flutter test``
## Translation
Translate the app to your language on [Weblate](https://hosted.weblate.org/engage/wger/).
@@ -70,7 +70,7 @@ Translate the app to your language on [Weblate](https://hosted.weblate.org/enga
## Contact
Feel free to get in touch if you found this useful or something didn't behave
Feel free to get in touch if you found this useful or if something didn't behave
as expected. We can't fix what we don't know about, so please report liberally.
If you're not sure if something is a bug or not, feel free to file a bug anyway.
@@ -83,7 +83,7 @@ If you're not sure if something is a bug or not, feel free to file a bug anyway.
The application is licensed under the GNU Affero General Public License 3 or later
(AGPL 3+) with an app store exception.
As an additional permission under section 7, you are allowed to distribute the
As additional permission under section 7, you are allowed to distribute the
software through an app store, even if that store has restrictive terms and
conditions that are incompatible with the AGPL, provided that the source is also
available under the AGPL with or without this permission through a channel without
@@ -92,3 +92,4 @@ those restrictive terms and conditions.
The initial exercise and ingredient data is licensed additionally under one of
the Creative Commons licenses, see the individual exercises for more details.