From 6d002d74ae37ae6cf6c1504435b8dea630a00cfe Mon Sep 17 00:00:00 2001 From: calm-steam Date: Wed, 19 Feb 2025 00:49:39 +0530 Subject: [PATCH] modify readme --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 50 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b69c10..e879067 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # GibCasa GameServerSupervisor ## Table of Contents -- [Prerequisites](#prerequisites) -- [Installation](#installation) +- [Installation using venv](#installation_venv) + - [Prerequisites](#prerequisites1) + - [Installation](#installation1) +- [Installation using Podman](#installation_podman) + - [Prerequisites](#prerequisites2) + - [Installation](#installation2) - [Usage](#usage) - [Contributing](#contributing) - [License](#license) -## Prerequisites +## Installation using venv + +### Prerequisites Python 3.10 or above -## Installation +### Installation 1. Clone the repository: ```bash @@ -45,6 +51,46 @@ Python 3.10 or above ```bash ./manage.py runserver ``` +## Installation using Podman + +### Prerequisites + +Podman + +### Installation + +1. Clone the repository: +```bash + git clone https://git.com.de/GibCasa/GameServerSupervisor +``` +2. Build the image: +```bash + podman build . -t supervisor-image +``` +3. Run a container in an interactive shell: +```bash + podman run -it --network=host localhost/supervisor-image sh +``` +4. Install dependencies: +```bash + pip install -r requirements.txt +``` +5. Run tests: +```bash + ./manage.py test +``` +6. Run migrations: +```bash + ./manage.py migrate +``` +7. Create admin user: +```bash + ./manage.py createsuperuser +``` +8. Run server: +```bash + ./manage.py runserver +``` ## Usage