GibCasa GameServerSupervisor

Table of Contents

• Installation using venv
  • Prerequisites
  • Installation
• Installation using Podman
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

Installation using venv

Prerequisites

Python 3.10 or above

Installation

1. Clone the repository:

  git clone https://git.com.de/GibCasa/GameServerSupervisor

2. Create a virtual environment in Python:

  python -m venv venv

3. Activate the virtual environment:

  source venv/bin/activate

4. Install dependencies:

  pip install -r requirements.txt

5. Run tests:

  ./manage.py test

6. Run migrations:

  ./manage.py migrate

7. Create admin user:

  ./manage.py createsuperuser

8. Run server:

  ./manage.py runserver

Installation using Podman

Prerequisites

Podman

Installation

1. Clone the repository:

  git clone https://git.com.de/GibCasa/GameServerSupervisor

2. Build the image:

  podman build . -t supervisor-image

3. Run a container in an interactive shell:

  podman run -it --network=host localhost/supervisor-image sh

4. Run tests:

  ./manage.py test

5. Run migrations:

  ./manage.py migrate

6. Create admin user:

  ./manage.py createsuperuser

7. Run server:

  ./manage.py runserver

---

To live sync host directory with container folder, in Step 3:

podman run --network=host -itv /host/src/path:/usr/src/GameServerSupervisor supervisor-image sh

/host/src/path is the absolute path to the repository in the host machine.

Usage

• Visit http://localhost:8000 for /public and http://localhost:8000/admin/ to login via the superuser credentials

Contributing

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes.
4. Push your branch: git push origin feature-name.
5. Create a pull request.

License

This project is licensed under the AGPL.