summaryrefslogtreecommitdiffstats
path: root/documentation/webapp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/webapp/README.md')
-rw-r--r--documentation/webapp/README.md40
1 files changed, 38 insertions, 2 deletions
diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md
index 473f161..17d06cc 100644
--- a/documentation/webapp/README.md
+++ b/documentation/webapp/README.md
@@ -1,6 +1,42 @@
# Webapplication
-The webapplikation is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API.
+
+<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme"></a>
+
+The webapplication is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API.
+
<a :href="$withBase('/img/home.png')" target="_blank"><img :src="$withBase('/img/home.png')" alt="BAS Home"></a>
+On the left side there is a sidepanel <span class="tutorial-label">1</span> with all the modules inside.
+The sidepanel can be opened and closed with <span class="tutorial-label">2</span>.
+There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings).
+<span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.
+<span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.
+<span class="tutorial-label">5</span> opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication.
+
+<a :href="$withBase('/img/user_menu.png')" target="_blank"><img :src="$withBase('/img/user_menu.png')" alt="BAS Home"></a>
+
+
+## User Account
+In the user account module the user is able to change some of his informations.
+
+<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
+
+With the edit Button <span class="tutorial-label">1</span> the user is able to change his ```NAME``` and his ```E-MAIL```.
+The change of the ```USERNAME``` is not possible in the account settings.
+
+::: tip
+The ```USERNAME``` can only be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required.
+:::
+
+The ```PASSWORD``` can be changed with pressing the <span class="tutorial-label">2</span> button. The requirements for a password are ```>= 8 characters```.
+
+With <span class="tutorial-label">3</span> the user can delete his account.
+::: danger
+Deleting your account with <span class="tutorial-label">3</span> can **NOT** be undone.
+:::
+
+## Settings
+
+<a :href="$withBase('/img/settings.png')" target="_blank"><img :src="$withBase('/img/settings.png')" alt="BAS Settings"></a>
+
## Notifications
-## Profile \ No newline at end of file