1. SudoVanilla recommends using the Bun package manager for Astro projects.
+2. If you plan to use Bun, NodeJS is not required to be installed, which is why it's not listed as a requirement. (Tested)
+### Clone Repository +Start by cloning the repository to somewhere on your device using the `git` command: +```bash +git clone https://ark.sudovanilla.org/korbs/project-pandora-charm/ +cd ./project-pandora-charm/ +``` + +### Install Packages +Install required packages so you can run the project: +```bash +bun install +``` + +### Run +Run the website with the run command: +```bash +bun start +``` + +The website should start running at [http://localhost:2014](http://localhost:2014). + +If the website is not running and an error appears, troubleshoot the problem by reading the error and try again. If the problem persist, submit an issue. + +## Hosting +### Requirements +It is expected for the server admin to use the Docker method, as it is recommended, so please install the Docker Engine. + + - [Install Docker Engine for Windows]() (WSL Method) + - [Install Docker Engine for macOS]() (Homebrew Method) + - [Install Docker Engine for Linux]() + +SudoVanilla does NOT recommend using the Docker Desktop application, as it is proprietary software. + +### Docker Compose (Recommended) +A Docker Compose file is provided that can be used without needing to clone the repository. Download the file to it's folder somewhere on your disk and run it. + +``` +services: + pandora-charm: + image: ark.sudovanilla.org/korbs/project-pandora-charm:amd64 + port: 2014:2014 +``` +> While simple and small, it is expected this will expand in the future and an all-in-one solution will be provided. ___Demo
\ No newline at end of file