From 31dd97342fd660f9be2f2802c856255a04848c39 Mon Sep 17 00:00:00 2001 From: jzitnik-dev Date: Sun, 31 May 2026 21:08:44 +0200 Subject: [PATCH] docs: Added readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b19b5f --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# JecnaClient + +JavaFX desktopová aplikace pro SPŠE Jecnou. Místo přepínání mezi pěti sekcemi webového informačního systému nabízí jednotné rozhraní pro známky, rozvrh, učitele, učebny, absence a Moodle. + +## Funkce + +- **Známky** – náhled podle předmětů, vážený průměr, možnost přidat fiktivní známku a sledovat její dopad na průměr +- **Rozvrh** – grid podle dní a vyučovacích hodin, interaktivní detaily včetně učitele a učebny +- **Učitelé** – seznam všech učitelů, profil s fotkou, emailem, kabinetem, konzultačními hodinami a rozvrhem +- **Učebny** – seznam místností, detail včetně třídního učitele a rozvrhu místnosti +- **Absence** – přehled zameškaných, neomluvených hodin a pozdních příchodů +- **Moodle** – vestavěný prohlížeč s automatickým přihlášením a úpravou vzhledu do tmavého režimu + +Přihlašovací údaje jsou šifrovány (AES-256-GCM) a ukládány lokálně, aby nebylo nutné se přihlašovat při každém spuštění. + +## Požadavky a spuštění + +- Java 21+ +- Maven + +```bash +git clone https://github.com/jzitnik/jecnaclient +cd jecnaclient +mvn clean javafx:run +``` + +## Technologie + +- JavaFX 21 + AtlantaFX (PrimerDark theme) +- JecnaAPI jako backendová knihovna +- Maven jako build systém + +## Proč + +Školní informační systém není zrovna přívětivý a tento projekt vznikl jako pokus o jeho snesitelnější alternativu.