Skip to content

Commit accaa71

Browse files
committed
Make clearer that the key is not needed
1 parent 5f92324 commit accaa71

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ If you want to contribute, hop on the Discord server and say hi!
88

99

1010
<p>
11-
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/01%20-%20dashboard.png" width="200" />
11+
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/01%20-%20dashboard.png" width="200" alt="" />
1212

13-
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/04%20-%20measurements.png" width="200" />
13+
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/04%20-%20measurements.png" width="200" alt="" />
1414

15-
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/05%20-%20nutritional%20plan.png" width="200" />
15+
<img src="https://raw.githubusercontent.com/wger-project/flutter/master/fastlane/metadata/android/en-US/images/phoneScreenshots/05%20-%20nutritional%20plan.png" width="200" alt="" />
1616
</p>
1717

1818
## Installation
@@ -40,30 +40,31 @@ Alternatively, you can use the test server (the db is reset every day):
4040

4141
### 2
4242

43-
Install Flutter, and all its dependencies, and create a new virtual device:
43+
Install Flutter and all its dependencies, and create a new virtual device:
4444
<https://flutter.dev/docs/get-started/install>.
4545

4646
The app currently uses flutter 3.16
4747

4848
### 3
49+
The application will complain about an API key not being set. You can just
50+
ignore this during development, this is only important if you want to register
51+
directly over the app. If you just want to login, you can skip this section.
4952

50-
Create a new file ``wger.properties`` in ``fastlane/metadata/envfiles/``:
53+
If you want to register directly over the app, you need to set a user on the backend
54+
that is allowed to do this. For this, create/register a new user, generate an api key
55+
and run ``python3 manage.py add-user-rest theusername`` (you can later list all the
56+
registered users with ``python3 manage.py list-users-api``).
57+
58+
Then create a new file ``wger.properties`` in ``fastlane/metadata/envfiles/`` and
59+
add the key:
5160

5261
```properties
5362
WGER_API_KEY=123456
5463
```
5564

56-
On Linux and macOS, add these as environment variables, e.g. by running the `source`
65+
Alternatively, add the key as an environment variables, e.g. by running the `source`
5766
command on the file.
5867

59-
To just run/develop the app it only needs to have any value for WGER_API_KEY, but
60-
you need a correct value if you want to register via the app. For this, you need
61-
to allow (a probably dedicated) user on the wger server to register users on its
62-
behalf. For this, generate an API KEY by visiting <http://localhost:8000/de/user/api-key>
63-
on your local instance and then run ``python3 manage.py add-user-rest the username``
64-
65-
You can later list all the registered users with: ``python3 manage.py list-users-api``
66-
6768
### 4
6869

6970
Start the application with ``flutter run`` or use your IDE
@@ -74,7 +75,7 @@ You can run the tests with the ``flutter test``
7475

7576
## Translation
7677

77-
Translate the app to your language on [Weblate](https://hosted.weblate.org/engage/wger/).
78+
Translate the app to your language on [Weblate](https://hosted.weblate.org/engage/wger/).
7879

7980
[![translation status](https://hosted.weblate.org/widgets/wger/-/mobile/multi-blue.svg)](https://hosted.weblate.org/engage/wger/)
8081

0 commit comments

Comments
 (0)