modify readme

This commit is contained in:
calm-steam 2025-02-16 15:50:11 +05:30
parent 9cec170f62
commit 9f82e689a1
Signed by: calm-steam
SSH Key Fingerprint: SHA256:VrjxFRfRdJ0oc+FjTdi2wneFAslmWVg6/r6Z773npjE

View File

@ -1,5 +1,11 @@
# GibCasa GameServerSupervisor
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
Python 3.10 or above
@ -22,18 +28,33 @@ Python 3.10 or above
```bash
pip install -r requirements.txt
```
5. Run unit tests:
```bash
./manage.py test
```
5. Run migrations:
```bash
python manage.py migrate
./manage.py migrate
```
6. Create admin user:
```bash
python manage.py createsuperuser
./manage.py createsuperuser
```
7. Run server:
```bash
python manage.py runserver
./manage.py runserver
```
* 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](https://www.gnu.org/licenses/agpl-3.0.html).