diff --git a/README.md b/README.md new file mode 100644 index 0000000..6719bfb --- /dev/null +++ b/README.md @@ -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 \ No newline at end of file diff --git a/backend/Program.cs b/backend/Program.cs index fdaa089..e220c4e 100644 --- a/backend/Program.cs +++ b/backend/Program.cs @@ -43,7 +43,6 @@ app.MapGet("/login", () => { app.MapGet("/api/v1/songs/{hash}", (string hash) => { - return Results.Ok(new { hash }); }); diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..1a6cbc3 --- /dev/null +++ b/docs/README.md @@ -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)
Arcitectur Diagramm
+ +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)
Authentication Process
+ +Now the Frontend can receive the quicktunnel base address and start requesting beatmaps, collection and audio. +![Step 3](image.png)
Autorized Usage
+ +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. diff --git a/docs/image.png b/docs/image.png new file mode 100644 index 0000000..cba03a9 Binary files /dev/null and b/docs/image.png differ diff --git a/docs/image2.png b/docs/image2.png new file mode 100644 index 0000000..451d22a Binary files /dev/null and b/docs/image2.png differ diff --git a/docs/image3.png b/docs/image3.png new file mode 100644 index 0000000..9632aa5 Binary files /dev/null and b/docs/image3.png differ