|
1 | 1 | # IPA Noten Rechner |
2 | 2 |
|
3 | | -Die Voraussetzungen für dieses Projekt sind zum Teil in [Projektbeschreibung](Projektbeschreibung.html) beschrieben. |
| 3 | +Eine Web-Applikation zur Selbstbewertung anhand des offiziellen [IPA Kriterienkatalogs](https://www.ict-berufsbildung.ch/resources/Kriterienkatalog_QV_BiVO2021_DE-20251025.pdf). |
4 | 4 |
|
5 | | -**Zudem soll folgendes implementiert werden:** |
6 | | -- Optionale Authentifizierung/Login (nur für uns, keine Registrierung möglich) |
7 | | -- Onboarding (optional nach Anmeldung) soll kommen, wenn Personendaten noch nicht erfasst wurden |
8 | | -- Hybridge Datenspeicherung (wenn angemeldet, über API in DB und sonst im LocalStorage mit Export funktion) |
9 | | -- Es wird ein langer Kriterienkatalog zusammengetragen in einer JSON Datei, welche dann angezeigt wird |
10 | | -- Jedes Kriterium soll in seine Kategorien eingeteilt werden |
11 | | -- Jedes Kriterium und jede Kategorie soll zusammenklappbar sein |
12 | | -- Am Anfang dieses Formulars soll eine kleine Übersicht sein, die den Fortschritt anzeigt und den Fortschritt in die Kategorien aufteilt |
13 | | -- Es soll möglich sein, die Noten live anzusehen in der Übersicht am Anfang |
| 5 | +## Features |
14 | 6 |
|
15 | | -## Get Started |
| 7 | +- 📋 Vollständiger Kriterienkatalog mit allen Bewertungskriterien |
| 8 | +- 📊 Live-Notenberechnung mit Fortschrittsanzeige |
| 9 | +- 💾 Hybride Datenspeicherung (LocalStorage oder Datenbank) |
| 10 | +- 🔐 Optionale Authentifizierung |
| 11 | +- 📤 Export/Import Funktionalität |
| 12 | +- 🎯 Unterstützung für Agile und Lineare Projektmethoden |
16 | 13 |
|
17 | | -Dependencies for |
18 | | -``` |
19 | | -npm, bun |
20 | | -``` |
| 14 | +## Quick Start |
21 | 15 |
|
22 | | -Install |
23 | | - |
24 | | -1. Clone and Install |
25 | 16 | ```bash |
| 17 | +# Repository klonen |
26 | 18 | git clone https://github.com/bbwheroes/324-ruts-ipa_noten_rechner-jannismilz |
27 | | -npm --prefix ./frontend install ./frontend && bun install --cwd ./backend |
28 | | -``` |
| 19 | +cd 324-ruts-ipa_noten_rechner-jannismilz |
29 | 20 |
|
| 21 | +# Dependencies installieren |
| 22 | +npm --prefix ./frontend install ./frontend |
| 23 | +bun install --cwd ./backend |
30 | 24 |
|
31 | | -2. Copy .env examples |
32 | | -```bash |
33 | | -cp frontend/.env.example frontend/.env && cp backend/.env.example backend/.env |
34 | | -``` |
| 25 | +# Umgebungsvariablen konfigurieren |
| 26 | +cp frontend/.env.example frontend/.env |
| 27 | +cp backend/.env.example backend/.env |
35 | 28 |
|
36 | | -3. Run database migrations: |
37 | | -```bash |
38 | | -bun run migrate |
39 | | -``` |
| 29 | +# Datenbank einrichten |
| 30 | +cd backend && bun run migrate |
40 | 31 |
|
41 | | -4. (Optional) Seed the database: |
42 | | -```bash |
43 | | -bun run seed |
| 32 | +# Server starten |
| 33 | +bun run dev # Backend (Port 3001) |
| 34 | +cd ../frontend && npm run dev # Frontend (Port 5173) |
44 | 35 | ``` |
45 | 36 |
|
46 | | -read more in [backend README](./backend/README.md) |
47 | | - |
48 | | -Start |
| 37 | +Für detaillierte Anweisungen siehe [CONTRIBUTING.md](./CONTRIBUTING.md). |
49 | 38 |
|
50 | | -Für Backend |
51 | | -```bash |
52 | | -cd backend |
53 | | -bun start |
54 | | -``` |
| 39 | +## Dokumentation |
55 | 40 |
|
56 | | -Es läuft auf localhost:3001 |
| 41 | +| Dokument | Beschreibung | |
| 42 | +|----------|--------------| |
| 43 | +| [CONTRIBUTING.md](./CONTRIBUTING.md) | Setup, Development, API Endpoints | |
| 44 | +| [Kriterienkatalog Spezifikation](./docs/KRITERIENKATALOG.md) | JSON-Format des Kriterienkatalogs | |
| 45 | +| [Testkonzept](./docs/TESTKONZEPT.md) | Teststrategie, Testfälle, Abdeckung | |
| 46 | +| [KI-Nutzung](./docs/KI_NUTZUNG.md) | Dokumentation der KI-Unterstützung | |
| 47 | +| [Backend README](./backend/README.md) | Backend-spezifische Dokumentation | |
57 | 48 |
|
| 49 | +## Projektstruktur |
58 | 50 |
|
59 | | -Für Frontend |
60 | | -```bash |
61 | | -cd backend |
62 | | -npm run dev |
63 | 51 | ``` |
64 | | - |
65 | | -Es läuft auf localhost:5173 |
66 | | - |
67 | | - |
68 | | -## Linter & Formatter |
69 | | - |
70 | | -*Frontend:* |
71 | | -```bash |
72 | | -npm run lint # Check for errors |
73 | | -npm run lint:fix # Auto-fix errors |
74 | | -npm run format # Format code |
75 | | -npm run format:check # Check formatting |
76 | | -``` |
77 | | - |
78 | | -*Backend:* |
79 | | -```bash |
80 | | -bun run lint # Check for errors |
81 | | -bun run lint:fix # Auto-fix errors |
82 | | -bun run format # Format code |
83 | | -bun run format:check # Check formatting |
84 | | -``` |
85 | | - |
86 | | -## Kriterienkatalog Spezifikation |
87 | | - |
88 | | -Für den [offiziellen Kriterienkatalog](https://www.ict-berufsbildung.ch/resources/Kriterienkatalog_QV_BiVO2021_DE-20251025.pdf). |
89 | | - |
90 | | -```json |
91 | | -{ |
92 | | - "categories_with_weigth": [ |
93 | | - { |
94 | | - "id": "hkb", // Eindeutige ID |
95 | | - "name": "Handlungskompetenzen", |
96 | | - "weight": 0.5, // 50% Gewichtung |
97 | | - "part": "Teil 1" // Teil 1 oder 2 für die Notenberechnung |
98 | | - }, |
99 | | - ], |
100 | | - "criterias": [ |
101 | | - { |
102 | | - "id": "A01", // Eindeutige ID |
103 | | - // id aus categories_with_weigth |
104 | | - "category": "hkb", |
105 | | - "title": "Auftragsanalyse und Wahl einer Projektmethode", |
106 | | - "subtitle": "Wie erfolgt die Auftragsanalyse? Welche Projektmethode kommtzum Einsatz?", |
107 | | - "selection": "multiple", // multiple (checkbox), single (radio) |
108 | | - // Selbe Reihenfolge wie im Kriterienkatalog |
109 | | - "requirements": [ |
110 | | - "Der Projektauftrag wurde analysiert und die Erkenntnisse mittels geeigneter Darstellungsmethoden (z. B. Zielstruktur, Use-Case- oder Kontextdiagramm, Anforderungstabelle) schriftlich dokumentiert.", |
111 | | - "Dokumentation aus Punkt 1 liefert die Grundlage, um die Projektziele konsequent zu verfolgen.", |
112 | | - "Eine zur Aufgabe passende Projektmethode wurde ausgewählt.", |
113 | | - "Die Wahl der Projektmethode ist nachvollziehbar und schriftlich begründet." |
114 | | - ], |
115 | | - "stages": { |
116 | | - // Gütestufe 3 |
117 | | - "3": { |
118 | | - // Alle Felder sind optional, aber es muss mindestens ein Feld definiert sein |
119 | | - "all": true, // Alle Bedingungen erfüllt |
120 | | - "count": 1, // 1 Bedingung erfüllt |
121 | | - "counts": [2, 3], // 2 oder 3 Bedingungen erfüllt |
122 | | - "count_less_than": 2, // Weniger als 2 Bedingungen erfüllt |
123 | | - "must": 4 // Genau Bedingung 4 erfüllt |
124 | | - }, |
125 | | - // ... |
126 | | - "0": { |
127 | | - // ... |
128 | | - } |
129 | | - } |
130 | | - } |
131 | | - // ... |
132 | | - ] |
133 | | -} |
| 52 | +├── backend/ # Express.js API mit Bun |
| 53 | +├── frontend/ # React + Vite |
| 54 | +├── shared/ # Geteilte Logik (Notenberechnung) |
| 55 | +├── docs/ # Dokumentation |
| 56 | +└── criterias.json # Kriterienkatalog |
134 | 57 | ``` |
135 | 58 |
|
136 | | -### Validierung |
| 59 | +## Tech Stack |
137 | 60 |
|
138 | | -```bash |
139 | | -bun run helpers/validate-criterias.js |
140 | | -``` |
| 61 | +- **Frontend:** React, Vite, Lucide Icons |
| 62 | +- **Backend:** Express.js, Bun, PostgreSQL |
| 63 | +- **Testing:** Bun Test, Vitest, Playwright |
| 64 | +- **CI/CD:** GitHub Actions, Docker |
0 commit comments