https://github.com/hbery/agh-class-divider
Aplikacja webowa do podziału zajęć dla studentów (projekt z MPT).
https://github.com/hbery/agh-class-divider
Last synced: 5 months ago
JSON representation
Aplikacja webowa do podziału zajęć dla studentów (projekt z MPT).
- Host: GitHub
- URL: https://github.com/hbery/agh-class-divider
- Owner: hbery
- Created: 2023-10-11T17:41:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T22:39:22.000Z (over 2 years ago)
- Last Synced: 2024-01-24T21:40:52.519Z (over 2 years ago)
- Language: Python
- Size: 7.56 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AGH Class Divider
Projekt realizowany na przedmiot "Metodyki Projektów Teleinformatycznych" w roku 2022/2023
## Twórcy ✨
socheck
hbery
agnieszkowe
krzysztof1235
kowaleuro
wik-kwik
vvafwgsv
## Opis projektu 📚
Projekt zakłada stworzenie aplikacji webowej służącej do podziału studentów na grupy zajęciowe według zgłoszonych preferencji za pomocą formularza - użyte zewnętrzne narzędzia. Zestaw preferencji jest eksportowany do formatu .csv, który następnie jest możliwy do wgrania na aplikację. Aplikacja za pomocą autorskiego algorytmu dokonuje przydziałów studenta do slotów zajęciowych, tak by w jak największym stopniu trspełnić jego preferencje. Ostatecznie osoba korzystająca z aplikacji otrzymuje plik .csv z przydziałem każdego studenta do grupy zajęciowej.
## Użyte technologie i języki
### Frontend
- React JS
### Backend
- Python
- Fast Api
### Środowisko wirtualizacyjne
- Docker
## WorkFlow projektu
- [tutaj](_docs/WORKFLOW.md)
## Opis algorytmu/modelu matematycznego
- [tutaj](/_docs/ENGINE_MODEL.md)
## Uruchomienie aplikacji
Całość aplikacji podzielona jest na dwa kontenery dockerowe, odpowiednio jeden dla Frontend i jeden dla Backend. Plik konfigurujący całe środowisko znajduje się w pliku `docker-compose.yml`, który pozwala na uruchomienie aplikacji za pomocą komendy `docker-compose up` będąc w zasięgu pliku. Komenda wystawia na porcie lokalnym `3000`, możliwość podłączenia się do strony www aplikacji.
- [instalacja Docker](https://docs.docker.com/get-docker/)
- [instalacja Docker compose](https://docs.docker.com/compose/install/)
## Zestawy testowe
Znajdują się w katalogu `tests/data/suite_{1..3}`