You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-12Lines changed: 29 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,8 @@
4
4
5
5
Manage your homework, with untis and discord support.
6
6
7
-
You can take/import pictures and assign them to a homework. Sharing/Synchronization of homework is also possible.
7
+
You can take/import pictures and assign them to a homework. Sharing/Synchronization of homework is
8
+
also possible.
8
9
9
10
### Untis
10
11
@@ -16,49 +17,65 @@ And secondly, for QOL, it can import the subjects you are going to have in the n
16
17
17
18
### Discord
18
19
19
-
You can use a combination of a bot and webhooks to achieve regulated homework ex-/import. The discord bot must have read message permissions for the channels, that could be used for homeworks. Furthermore, he should be member of only one guild.
20
+
You can use a combination of a bot and webhooks to achieve regulated homework ex-/import. The
21
+
discord bot must have read message permissions for the channels, that could be used for homeworks.
22
+
Furthermore, he should be member of only one guild.
20
23
21
24
You can "export"(send) your homework easily, by:
25
+
22
26
1. Creating and assigning a subject
23
27
2. Specifying a bot (token)
24
28
3. Creating a discord relation, this must be assigned to the target channel to support import
25
29
4. Specifying the webhook url for the given channel
26
30
5. Clicking send on the homework
27
31
32
+
If the discord relations are configured, you can just click on the fetch icon in the upper right
33
+
corner of the home screen. This may overwrite local changes, so be careful.
34
+
35
+
## TODO
28
36
29
-
If the discord relations are configured, you can just click on the fetch icon in the upper right corner of the home screen. This may overwrite local changes, so be careful.
37
+
-[ ] Qrcode generator to share webhooks and bot token
30
38
31
39
## Getting Started / Installation
40
+
32
41
<detailsopen>
33
42
<summary><h3style="display:inline-block">An online(ish) app is enough for me </h3></summary>
34
43
35
-
> <b>BE WARNED: If you use the app with a bot token on the web, you are sending your token to a CORS proxy that redirects it to discord. Someone (in this case Cloudflare) could sniff your token. Unfortunately a CORS proxy is needed on the web, because discord does not send adequate CORS.</b>
44
+
> <b>BE WARNED: If you use the app with a bot token on the web, you are sending your token to a CORS
45
+
> proxy that redirects it to discord. Someone (in this case Cloudflare) could sniff your token.
46
+
> Unfortunately a CORS proxy is needed on the web, because discord does not send adequate CORS.</b>
36
47
37
-
If you took notice of this warning, you can just open the GitHub Pages app: [https://randommodderjdk.github.io/hw_manager_flutter](https://randommodderjdk.github.io/hw_manager_flutter)
48
+
If you took notice of this warning, you can just open the GitHub Pages
Use your browser to create a web app on android. Search for "Add Shortcut" or anything similar.
52
66
53
-
This is like the native app (except the security), especially when the browser caches it. Tested with Chromium-based browsers and firefox.
67
+
This is like the native app (except the security), especially when the browser caches it. Tested
68
+
with Chromium-based browsers and firefox.
54
69
55
70
</details>
56
71
</details>
57
-
<detailsopen><summary><h3style="display:inline-block">I prefer the native app</h3></summary>
72
+
<detailsopen><summary><h3style="display:inline-block">I prefer the native app [recommended]</h3></summary>
58
73
59
-
**If you are on android** and go ahead to releases and download your arch.
74
+
**If you are on android**, go ahead to releases and download your arch.
60
75
61
-
**If you are on ios**, download the ipa (native app) in the releases, if you know how to install it. This is not really signed. I would recommend Alt-/Troll-/Sidestore. When Apple allows apps to finally be installed like on android, then do it that way.
76
+
**If you are on ios**, download the ipa (native app) in the releases, if you know how to install it.
77
+
This is not really signed. I would recommend Alt-/Sidestore. When Apple allows apps to
78
+
finally be installed like on android, then do it that way.
62
79
63
80
**If you'd like any other platform**:
64
81
Clone this repo, (add your platform,), build HWM (and maybe contribute a GitHub action) yourself.
0 commit comments