e5vosdo-snimrod

Modern webapplikáció az Eötvös József Gimnázium Diákönkormányzatának

Tervezte és fejlesztette: Simon Nimród

---

📱 Hamarosan Android alkalmazás!

PWA változat már elérhető a weben, a bal fenti letöltés ikonra kattintva: e5vosdo.hu

---

📋 Tartalom

• 🎯 Áttekintés
• 🎨 Funkciók
• 🛠️ Technológiai stack
• 🚀 Kezdő lépések
• 📄 Licenc
• 🙏 Köszönetnyilvánítás

---

🎯 Áttekintés

Az e5vosdo-snimrod egy korszerű, full-stack webapplikáció, amely az Eötvös József Gimnázium diákjainak és tanárainak mindennapi iskolai életét segíti. A platform modern technológiákra épül, intuitív felhasználói élményt és gyors teljesítményt biztosítva.

A projekt nemcsak egy eszköz, hanem egy közösségi nyílt forrású kezdeményezés is, amely lehetővé teszi a diákok számára, hogy tapasztalatot szerezzenek a webfejlesztés terén, miközben hozzájárulnak iskolájuk digitális környezetének fejlesztéséhez.

✨ Miért ez a projekt?

• 🚀 Modern architektúra: Next.js 16 alapú, server-side rendering és optimalizált teljesítmény
• 💅 Elegáns design: HeroUI komponensek és Tailwind CSS styling
• 🔒 Biztonságos: Google authentikáció (szervezeti szintű) és jogosultságkezelés
• 📱 Reszponzív: Mobil-első megközelítés, minden eszközön tökéletes megjelenés
• 💡 Szabad fejlesztés: Nyílt forráskódú, közösségi hozzájárulásokra ösztönző projekt
• 🤝 Közösségközpontú: Eseményfeltöltési lehetőségek és közösségi interakciók

🎨 Funkciók

• 📅 Órarend kezelés: Valós idejű órarend és helyettesítések megjelenítése
• 🎭 Események: Iskolai programok és események koordinálása
• 🍽️ Menza: Naprakész menü információk
• ⚽ Sport: Sportprogramok és edzések nyilvántartása
• 👤 Felhasználói profilok: Személyre szabott beállítások és preferenciák
• 🔔 Értesítések: PWA támogatás push notifikációkkal
• 🌙 Téma váltás: Világos, sötét és egyedi témák
• 🏫 Teremfoglaltság: Hamarosan

---

🛠️ Technológiai stack

• Next.js 16 - React framework server-side renderinggel
• TypeScript - Type-safe fejlesztés
• HeroUI - Modern UI komponenskönyvtár
• Tailwind CSS - Utility-first CSS framework
• Framer Motion - Smooth animációk
• next-themes - Téma kezelés
• MySQL - Relációs adatbázis

DevOps

• Docker - Konténerizált deployment
• Python - Segédeszközök és scraping

Egyéb használt technológiák

• Google Analytics
• Google Cloud
• Supabase Storage

---

🚀 Kezdő lépések

1. Előfeltételek telepítése

• Node.js & npm 18.x+: https://nodejs.org/en/download/
• Git verziókezelő: https://git-scm.com/downloads
• MySQL 8.4+: https://dev.mysql.com/downloads/mysql/
• Python 3.8+ (a setup script futtatásához & fejlesztői eszközökhöz): https://www.python.org/downloads/

2. Repo klónozása

git clone https://github.com/sibosi/e5vosdo-snimrod.git
cd e5vosdo-snimrod

3. Csomagok telepítése

npm install

pip install -r requirements.txt

4. Adatbázis séma letöltése

FONTOS! Az első lépésben le kell töltened az adatbázis sémát az admin endpointról:

1. Kérj hozzáférést a fő fejlesztőtől
2. Nyisd meg: https://e5vosdo.hu/api/admin/export-schema
3. Ez automatikusan letölt egy db_schema_YYYY-MM-DD.sql fájlt
4. Másold a fájlt a projekt gyökérkönyvtárába

5. Környezeti változók beállítása

Másold a .env.example fájlt .env néven:

cp .env.example .env

Írd át a .env fájlban a MySQL kapcsolati adatokat a saját környezetednek megfelelően.

MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=e5info
MYSQL_USER=your_mysql_user
MYSQL_PASSWORD=your_mysql_password

6. Setup script futtatása

Futtasd az automatizált setup scriptet:

python setup_project.py

7. Fejlesztői szerver indítása

npm run dev

A projekt elérhető lesz a http://localhost:3000 címen.

---

📄 Licenc

A projekt vagy bármely része kizárólag a szerző írásos engedélyével terjeszthető vagy használható.

Licensed under the MIT license.

---

🙏 Köszönetnyilvánítás

Külön köszönet mindenkinek, aki hozzájárult a projekt sikeréhez:

💪 Támogatók

• Domi - Aki "jó fej" (mindenkori motivátor)
• Zsolt - Segítség mindenben is
• Barnabás - Tanácsadás és ihletszerzés
• Lajos - Szerverszerzési ötletek
• Nikó - A palánta
• Ádám - A transzfermester
• Ábel - Tanácsadás

🧪 Tesztelők

• Vince - Az örök Android tesztelő
• Timi - Az örök iOS tesztelő, aki sajnos (vagy nem sajnos) Androidra váltott
• Hanna - Az új iOS tesztelő

---

Készítette Simon Nimród

Az Eötvös József Gimnázium Diákönkormányzatának

📧 Email • 🐛 Issue beküldése