add prerequisites

This commit is contained in:
calm-steam 2025-02-03 11:21:25 +05:30
parent 0f042f78ea
commit 8b44b8a952
Signed by: calm-steam
SSH Key Fingerprint: SHA256:VrjxFRfRdJ0oc+FjTdi2wneFAslmWVg6/r6Z773npjE

View File

@ -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
http://localhost:8000/admin/ to login via the superuser credentials
* will need docker running