readme

README.md

@@ -30,37 +30,85 @@ A free & opensource Minecraft Dashboard to control your server
 - Java JRE (for minecraft)
 - git
 
-
 ## Development
-add a folder called `server` and put the `paper.jar` file in it that will run the server
-add a eula file that has`eula=true` in it ...
-Visit the `.env` file and change the token, websocket port there
+Visit the `dash/.env` file and change the token, websocket port there
+
+For Development you need the have
+- rust
+- nodejs
 
-- cargo
-- node
+---
 
+```sh
+cd dash
+cargo run
+```
+will run the Websocket / API server
 
 ```sh
 pnpm install
 pnpm run dev
 ```
-will run the frontend on http://localhost:3000/dashboard
+will run the frontend on http://localhost:3000/
+
+## Deployment
+
+#### Build the Backend / Server
+This is not optimal currently and I plan in the further future if there are some people actually using this (open an issue if you do :D) to make 
+a script to setup this and docker containers (or at least the Dockerfile & docker compose file)
+
+**Config**
+Visit the `dash/.env` file and change the token, websocket port there
+
+**Build**
+Build the Backend with 
+```sh
+# cd dash (if you are not in the directory of the backend)
+cargo build --release
+cp target/release/dash dash.bin
+chmod +x dash.bin 
+```
+
+Build the Frontend with
+```sh
+# in the project directory 
+pnpm install
+pnpm run build
+pnpm run start
+```
+
+> now the backend is running on localhost and the frontend too 
+
+**Setup a Reverse Proxy**
+I recommend the Docker Container _Nginx Proxy Manager_
+
+than configure it to let your domain e.g. the www, @ record (with https) to redirect to localhost:3000
+and another record e.g. api to redirect to localhost:{your port for the backend e.g. 8778, see the dash/.env file}, also with https
+
+
+Visit the `.env.local` file and the api url to the public adress you run the server on e.g. (https://api.{your_domain}/...)
 
+**Tmux Sessions**
+open a new tmux session (`tmux`)
+
+_Session 1_
 ```sh
 cd dash
-cargo run
+./dash.bin
 ```
-will run the Websocket / API server
 
+(press _ctrl + b_ to detach)
+
+_Session 2_
+```sh
+pnpm run start
+```
 
-Download the current paper server
-and upload it in the file explorer as `server.jar` 
-also upload a `eula.txt` with the content `eula=true` up
+(again detach)
 
+> Now you should be alow to visit the dashboard on your domain :)
 
-## Deployment
 
-#### Build the Backend / Server
-...
+#### Questions? 
 
-(explanation in progres ...)
+Please open an issue if you have any questions, im glad to help you :D

app/page.tsx

@@ -5,7 +5,7 @@ export default function Home() {
   return (
     <main className="flex min-h-screen flex-col items-center justify-between p-24">
       <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
-        <p>The current default token is: 1234</p>
+        <p>The default token is: 1234</p>
         <Link href="/login"><Button variant="secondary">Login</Button></Link>
       </div>
     </main>