DiamonC
0f740d5b78
Reviewed-on: #14 |
||
|---|---|---|
| src | ||
| static | ||
| .dockerignore | ||
| .gitignore | ||
| .npmrc | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| jsconfig.json | ||
| package-lock.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| postcss.config.cjs | ||
| svelte-instructions.md | ||
| svelte.config.js | ||
| tailwind.config.cjs | ||
| vite.config.js | ||
| vite.config.js.timestamp-1663894955710.mjs | ||
| vite.config.js.timestamp-1666802308964.mjs | ||
| yarn.lock | ||
README.md
Warnings
- Arth Panel is in beta and should not be used in production yet.
- There are several issues with the docker image currently, and we reccomend running observer directly for now.
About Observer
Observer is a frontend for Arth Panel, a lightweight self-hosted Minecraft server panel. Observer is made with HTML/CSS/JS, Node, SvelteKit, TailwindCSS, and DaisyUI.
How to run without docker
- Grab the source code with
git clone https://codeberg.org/arth/quartz - Install packages with
npm i - Build the source code with
CI= npm run build - Run with
node build
Other Requirements
- By default, observer will connect to Arth's quartz backend. To create your own functioning service you will need to set up a quartz backend and replace the address at the top of src/lib/scripts/req.ts.
How to Run with Docker
- Download the image from docker hub with the command
sudo docker pull arthmc/observer:latest - Run the image with
sudo docker run -p 3000:3000 arthmc/observer:latest. To change the port, replace the first 3000 with the port number you want.
Contributing
How to run a dev server
- Make sure you install the packages by running
npm i - To run a dev server, enter the command
npm run dev - If you need to mimic a production environment for something like working with Service Workers, enter
npm run previewinstead.
Contributing Guidelines
- Please format your code with Prettier, or an alternative that achieves the same results.
- Please use feather for svg icons & use webp for raster images whenever possible. If you're wondering what tools have been used to make images like the arth logo (seen on arthmc.xyz) and the favicon, they were made with Lunacy.
Check out our backend's progress
Why Arth Panel?
The main difference between Arth Panel and an alternative like pufferpanel or pterodactyl is that it's meant to work in a way so that if an issue were to occur, you could easily just SSH into the machine and run the jar directly in a folder, so you know that your server's uptime is not dependant on a panel someone else made working flawlessly.
To-do list
✅ Setup a basic node application with Svelte, Tailwind, & DaisyUI.
✅ Navbar with Arth Panel, Servers, & Settings on left. On right: Night/darkmode button, Create server button, Account button.
✅ Basic UI for all planned pages
✅ Communication with backend
✅ Subscriptions with stripe
✅ Basic UI and function for terminal on the frontend
❌ Signin via discord