juli0n21/pwa-player
1
0
Fork 0
mirror of https://github.com/JuLi0n21/pwa-player.git synced 2026-04-19 15:30:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

add minidocumentation

Browse Source
This commit is contained in:
Julian Schlüter
2024-09-21 22:48:48 +02:00
parent f26529b1a3
commit acaedfe8c7
6 changed files with 33 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.md Normal file
View File

@@ -0,0 +1,13 @@
# How it works
To ensure users have secure access to their beatmaps through a shared website and prevent unauthorized users from accessing the Beatmaps. The following steps are taken.
![Step 1](image3.png) <div align="center"> Arcitectur Diagramm</div>
The process begins by authenticating both the locally running web server (which exposes the beatmaps and collections) and the frontend interface with a proxy server. This ensures that only authorized users can access the beatmaps.
After authentication, the backend (the local web server) sends its quicktunnel base address to the proxy, which assosiates the endpoint with the logged in user.
![Step 2](image2.png) <div align="center"> Authentication Process</div>
Now the Frontend can receive the quicktunnel base address and start requesting beatmaps, collection and audio.
![Step 3](image.png) <div align="center"> Autorized Usage</div>
This system is architected to provide convenient and consistent access to beatmaps by eliminating the need to worry about the changing domain names of Cloudflare quicktunnels. Aswell as the possiblity to share ur beatmaps with friends.