From 7dc24f145693b06161a63a58f7d5ade0bcc1a443 Mon Sep 17 00:00:00 2001 From: calm-steam Date: Sun, 16 Feb 2025 11:17:50 +0530 Subject: [PATCH 1/5] remove docker reference in readme --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 3a1554f..297f0bc 100644 --- a/README.md +++ b/README.md @@ -36,5 +36,4 @@ Python 3.10 or above ``` * visit http://localhost:8000 for /public and http://localhost:8000/admin/ to login via the superuser credentials -* will need docker running -- 2.35.3 From 98b9574c67c9e236ff0f80f081fb689aafe1196b Mon Sep 17 00:00:00 2001 From: calm-steam Date: Sun, 16 Feb 2025 13:40:32 +0530 Subject: [PATCH 2/5] delete webpanel/tests.py --- webpanel/tests.py | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 webpanel/tests.py diff --git a/webpanel/tests.py b/webpanel/tests.py deleted file mode 100644 index 7ce503c..0000000 --- a/webpanel/tests.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.test import TestCase - -# Create your tests here. -- 2.35.3 From 9cec170f620fcac96076204f1d6b17d3d11f9b8e Mon Sep 17 00:00:00 2001 From: calm-steam Date: Sun, 16 Feb 2025 15:26:29 +0530 Subject: [PATCH 3/5] add webpanel/test_models.py as example --- webpanel/test_models.py | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 webpanel/test_models.py diff --git a/webpanel/test_models.py b/webpanel/test_models.py new file mode 100644 index 0000000..6769b1b --- /dev/null +++ b/webpanel/test_models.py @@ -0,0 +1,11 @@ +from django.test import TestCase +from webpanel.models import Game + +class GameTestCase(TestCase): + def setUp(self): + Game.objects.create(name="Assassin's Creed") + + def test_game_creation(self): + assassins = Game.objects.get(name="Assassin's Creed") + assert str(assassins) == "Assassin's Creed" + -- 2.35.3 From 9f82e689a1d3bf6cc82894f50561b4fc46df2b11 Mon Sep 17 00:00:00 2001 From: calm-steam Date: Sun, 16 Feb 2025 15:50:11 +0530 Subject: [PATCH 4/5] modify readme --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 297f0bc..3b1c593 100644 --- a/README.md +++ b/README.md @@ -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). -- 2.35.3 From 07c1a2d8d65db96effcb42a12d64467782e1ac1b Mon Sep 17 00:00:00 2001 From: calm-steam Date: Sun, 16 Feb 2025 15:55:33 +0530 Subject: [PATCH 5/5] fix readme --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3b1c593..1b69c10 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ ## Table of Contents - [Prerequisites](#prerequisites) - [Installation](#installation) +- [Usage](#usage) - [Contributing](#contributing) - [License](#license) @@ -28,23 +29,26 @@ Python 3.10 or above ```bash pip install -r requirements.txt ``` -5. Run unit tests: +5. Run tests: ```bash ./manage.py test ``` -5. Run migrations: +6. Run migrations: ```bash ./manage.py migrate ``` -6. Create admin user: +7. Create admin user: ```bash ./manage.py createsuperuser ``` -7. Run server: +8. Run server: ```bash ./manage.py runserver ``` -* visit http://localhost:8000 for /public and + +## Usage + +* Visit http://localhost:8000 for /public and http://localhost:8000/admin/ to login via the superuser credentials ## Contributing @@ -58,3 +62,4 @@ Python 3.10 or above ## License This project is licensed under the [AGPL](https://www.gnu.org/licenses/agpl-3.0.html). + -- 2.35.3