diff --git a/README.md b/README.md index 3a1554f..1b69c10 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # GibCasa GameServerSupervisor +## Table of Contents +- [Prerequisites](#prerequisites) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + ## Prerequisites Python 3.10 or above @@ -22,19 +29,37 @@ Python 3.10 or above ```bash pip install -r requirements.txt ``` -5. Run migrations: +5. Run tests: ```bash - python manage.py migrate + ./manage.py test ``` -6. Create admin user: +6. Run migrations: ```bash - python manage.py createsuperuser + ./manage.py migrate ``` -7. Run server: +7. Create admin user: ```bash - python manage.py runserver + ./manage.py createsuperuser +``` +8. Run server: +```bash + ./manage.py runserver ``` -* visit http://localhost:8000 for /public and - http://localhost:8000/admin/ to login via the superuser credentials -* will need docker running + +## Usage + +* 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). 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" + 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.