Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1.84 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.84 KB

GwardiaHub Project 🌐

📄 About the project

We want to create website with Django, that will be useful to as many as three different user groups!

  • Our classmates
  • Gwardia Czapli members
  • Genshin Impact players from both of above

Modules

  • For all our classmates:
    • information about lunch menu for given day,
    • calendar with events from Mobidziennik and other events, that our class want to include,
    • information about our homeworks with option to submit solution.
  • For Gwardia Czapli members:
    • information about next meetings,
    • place to submit feedback about meetings,
    • assignments given on meetings.
  • For Genshin Impact players:
    • wish (it's something like lootboxes in Genshin) simulator with character collection book,
    • banners and events info,
    • daily check in reminder,
    • Genshin inspired, this module exclusive, UI and UwU color theme.

🛠️ Installation guide for contributors

Installation

  1. Install git
  2. In terminal go to folder where you want to have this repository, fe. Documents and enter git clone https://github.com/Gwardia-Czapli/GwardiaHub command
  3. Install python-poetry
  4. In terminal go to repository folder (if we follow example from 2. it will be Documents/GwardiaHub) and enter poetry install
  5. Install pre-commit
  6. In terminal go to repository folder and enter and pre-commit install
  7. Open IDE (preferably PyCharm) and with Open folder option open repository folder as project in your IDE
  8. Install Docker and Docker Compose

Server running

  1. If you installed Docker Desktop open it
  2. Open terminal in repo folder
  3. Enter docker compose up
  4. Open new terminal window
  5. Enter python manage.py runserver