Harcerski-System-Stopni

System wspierający działanie Komisji Stopni Instruktorskich
Cyfrowa platforma do zarządzania próbami harcerskimi, dokumentacją i organizacji posiedzeń komisji.

---

📋 Spis treści

• Opis
• Funkcjonalności
• Technologie
• Struktura katalogów
• Uruchomienie lokalne
• Licencja
• Autor

---

📖 Opis

Aplikacja webowa, której celem jest wsparcie członków komisji instruktorskiej w ich pracy. Umożliwia zgłaszanie prób przez harcerzy, zatwierdzanie ich przez uprawnione osoby, zarządzanie kalendarzem spotkań oraz archiwizowanie dokumentacji.

W przyszłości planowana jest implementacja OCR, systemu powiadomień.

---

✨ Funkcjonalności

• Rejestracja i logowanie użytkowników z przypisaną rolą (JWT)
• Przesyłanie prób przez użytkowników
• Panel komisji/kapituły do zatwierdzania prób
• Kalendarz z zapisami na posiedzenie komisję
• Archiwum dokumentów komisji
• (W planie) system powiadomień

---

🛠 Technologie

Typ	Technologia
Backend	NestJS (TypeScript)
Baza danych	MySQL (TypeORM)
Autoryzacja	JWT
Frontend	React (w planach)
OCR / PDF	Rozważane

---

📁 Struktura katalogów

hss/
├── server/        # Backend (NestJS, zawiera package.json)
├── docs/           # Dokumentacja (roadmap, wymagania)
├── README.md       # Główna dokumentacja projektu
└── .env.example    # Zmienne środowiskowe

🚀 Uruchomienie lokalne

# 1. Klonowanie repozytorium
git clone https://github.com/Nikovsky/Harcerski-System-Stopni.git
cd Harcerski-System-Stopni/server

# 2. Instalacja zależności (w katalogu server)
npm install

# 3. Utwórz plik konfiguracyjny
cp .env.example .env

# 4. Start serwera developerskiego
npm run start:dev

📄 Licencja

Ten projekt jest objęty licencją CC BY-NC 4.0). Zobacz LICENSE po więcej informacji.

👤 Autor

Projekt tworzony przez Nikovsky, jako część portfolio i narzędzie wspierające lokalną społeczność harcerską.