mirror of
https://github.com/JuLi0n21/pwa-player.git
synced 2026-04-19 15:30:05 +00:00
add minidocumentation
This commit is contained in:
20
README.md
Normal file
20
README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# osu! PWA player
|
||||
|
||||
Website to listen to ur beatmaps and Collections
|
||||
[https://music.illegalesachen.download/](https://music.illegalesachen.download/)
|
||||
|
||||
## Requirements
|
||||
- [cloudflared](https://github.com/cloudflare/cloudflared/releases/)
|
||||
- [.net 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
|
||||
|
||||
## Tutorial
|
||||
1. Install the Requirements
|
||||
2. Download the backend, run it and follow the instruction presentend to u in the terminal
|
||||
3. Login with ur osu account on the Website
|
||||
4. Add the Website to ur Homescreen
|
||||
5. Enjoy
|
||||
|
||||
### FAQ
|
||||
- Yes, ur pc needs to run while u want to listen
|
||||
- How does it work -> [How it works](docs/README.md)
|
||||
- I dont want to use the website but my own -> hit me up ill help u set it up
|
||||
@@ -43,7 +43,6 @@ app.MapGet("/login", () => {
|
||||
|
||||
app.MapGet("/api/v1/songs/{hash}", (string hash) =>
|
||||
{
|
||||
|
||||
return Results.Ok(new { hash });
|
||||
});
|
||||
|
||||
|
||||
13
docs/README.md
Normal file
13
docs/README.md
Normal 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.
|
||||
|
||||
 <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.
|
||||
 <div align="center"> Authentication Process</div>
|
||||
|
||||
Now the Frontend can receive the quicktunnel base address and start requesting beatmaps, collection and audio.
|
||||
 <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.
|
||||
BIN
docs/image.png
Normal file
BIN
docs/image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
BIN
docs/image2.png
Normal file
BIN
docs/image2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
BIN
docs/image3.png
Normal file
BIN
docs/image3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 162 KiB |
Reference in New Issue
Block a user