From 8b44b8a9522fb9504f3df3a4963bd8ab65b0d5a7 Mon Sep 17 00:00:00 2001 From: calm-steam Date: Mon, 3 Feb 2025 11:21:25 +0530 Subject: [PATCH] add prerequisites --- README.md | 45 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 01f7b6d..4b5ce0a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,40 @@ # GibCasa GameServerSupervisor -# Setup +## Prerequisites +Python 3.10 or above -* clone the repo -* create venv `python3 -m venv venv` -* activate `source venv/bin/activate` -* `pip install -r requirements.txt` -* will need docker running -* `python manage.py migrate` -* Create admin user: `python manage.py createsuperuser` -* `python manage.py runserver` +## Installation + +1. Clone the repository: +```bash + git clone https://git.com.de/GibCasa/GameServerSupervisor +``` +2. Create a virtual environment in Python: +```bash + python3 -m venv venv +``` +3. Activate the virtual environment: +```bash + source venv/bin/activate +``` +4. Install dependencies: +```bash + pip install -r requirements.txt +``` +5. Run migrations: +```bash + python manage.py migrate +``` +6. Create admin user: +```bash + python manage.py createsuperuser +``` +7. Run server: +```bash + python manage.py runserver +``` * visit http://localhost:8000 for /public and - http://localhost:8000/admin/ to login via the superuser credentials \ No newline at end of file + http://localhost:8000/admin/ to login via the superuser credentials +* will need docker running +