Files
WebJelly-Rescue/README.md
T
2025-02-17 11:43:52 +01:00

40 lines
936 B
Markdown

# WebJelly-Rescue
[Jelly Rescue](https://github.com/Ninjaws/JellyGame), but now for the web!
## Installation
### Install Docker
- On Windows and Mac
```
Install Docker Desktop
Windows: https://docs.docker.com/desktop/install/windows-install/
Mac: https://docs.docker.com/desktop/install/mac-install/
```
- On Linux
```bash
# For Debian-based systems
sudo apt install -y docker.io
sudo apt install docker-compose
#For Arch-based systems
sudo pacman -S docker.io
sudo pacman -S docker-compose
# Making Docker run now and on startup
sudo systemctl start docker
sudo systemctl enable docker
# Using the CLI without sudo
sudo usermod -aG docker $USER
sudo reboot
```
## How to run
- Navigate to the root of the project
- Open a terminal
- Start the container:
```bash
docker compose up # Might take a few minutes to build
```
- Visit https://localhost:4600 to play the game locally
- Or play it live [here!](https://jelly.ianvink.nl)