wis2/docs.html at master · DiceNameIsMy/wis2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- saved from url=(0053)file:///home/nur/Projects/vut-iis-wis2/docs/docs.html -->
<html data-darkreader-proxy-injected="true">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  <title>Projekt IIS</title>
  <style type="text/css">
    table {
      border-collapse: collapse;
    }

    td,
    th {
      border: 1px solid black;
      padding: 0.3em 0.5em;
      text-align: left;
    }

    dt {
      font-weight: bold;
      margin-top: 0.5em;
    }
  </style>
</head>

<body data-new-gr-c-s-check-loaded="14.1255.0" data-gr-ext-installed="">

  <h1>WIS2</h1>

  <dl>
    <dt>Autoři</dt>
    <dd>Nurdaulet Turar
      <a href="mailto:xturarn00@stud.fit.vutbr.cz">xturarn00@stud.fit.vutbr.cz</a> -
      Autentizace, Deployment, Inicializace projektu, Skripty, BE a FE
    </dd>
    <dd>Ivan Savin
      <a href="mailto:xsavini00@stud.fit.vutbr.cz">xsavini00@stud.fit.vutbr.cz</a> -
      BE a FE
    </dd>
    <dd>Oleh Krasovskyi
      <a href="mailto:xkrasoo00@stud.fit.vutbr.cz">xkrasoo00@stud.fit.vutbr.cz</a> -
      BE a FE
    </dd>
    <dt>URL aplikace</dt>
    <dd>Frontend: <a href="https://vut-iis-wis2.onrender.com/">https://vut-iis-wis2.onrender.com/</a></dd>
    <dd>API: <a href="https://vut-iis-wis2-api.onrender.com/">https://vut-iis-wis2-api.onrender.com/</a></dd>
    <dd><em>Poznámka: Deployed verze může vyžadovat ~1 minutu na spuštění backendu (API).</em></dd>
  </dl>

  <h2>Uživatelé systému pro testování</h2>
  <p>Uveďte prosím existující zástupce <strong>všech rolí uživatelů</strong>.</p>
  <table>
    <tbody>
      <tr>
        <th>Login</th>
        <th>Heslo</th>
        <th>Role</th>
      </tr>
      <tr>
        <td>admin@email.com</td>
        <td>admin</td>
        <td>Administrátor</td>
      </tr>
      <tr>
        <td>teacher1@email.com</td>
        <td>password</td>
        <td>Teacher and Guarant of courses</td>
      </tr>
      <tr>
        <td>user1@email.com</td>
        <td>password</td>
        <td>Student of courses</td>
      </tr>
    </tbody>
  </table>

  <h3>Diagram případů užití</h3>
  <img src="docs/use_case.png" alt="Use Case Diagram" style="max-width: 100%;" />

  <h3>Video</h3>

  <a href="https://drive.google.com/file/d/132Spmyr0SbTmFRORpN1TvLKyFt9bipeD/view?usp=sharing">Odkaz</a>

  <h2>Implementace</h2>

  <h3>Technologie</h3>
  <ul>
    <li><strong>Backend:</strong> Python, Django, Django REST Framework</li>
    <li><strong>Frontend:</strong> TypeScript, React, Vite, Axios</li>
    <li><strong>Databáze:</strong> PostgreSQL</li>
    <li><strong>Deployment:</strong> Render.com</li>
  </ul>

  <h3>Architektura</h3>
  <p>Aplikace následuje client-server architekturu s odděleným frontendem a backendem:</p>
  <ul>
    <li><strong>Frontend:</strong> React SPA (Single Page Application) komunikující s backendem přes RESTful API</li>
    <li><strong>Backend:</strong> Django REST API server poskytující JSON endpointy</li>
    <li><strong>Databáze:</strong> PostgreSQL pro persistentní uložení dat</li>
    <li><strong>Autentizace:</strong> Session-based authentication s CSRF ochranou</li>
  </ul>

  <h3>Struktura Backendu (Django)</h3>
  <p>Backend je organizován do Django aplikací:</p>
  <ul>
    <li><strong>accounts</strong> - správa uživatelů a autentizace
      <ul>
        <li><code>api/views.py</code> - API views pro registraci, přihlášení, profil, správu uživatelů</li>
        <li><code>api/serializers.py</code> - serializery pro validaci a transformaci dat</li>
        <li><code>api/urls.py</code> - URL routing pro auth endpoints</li>
      </ul>
    </li>
    <li><strong>courses</strong> - správa kurzů, termínů a hodnocení
      <ul>
        <li><code>models.py</code> - modely Course, Student, Lector, Term, Grade, Location</li>
        <li><code>api/views.py</code> - API views pro CRUD operace s kurzy, termíny a hodnocením</li>
        <li><code>api/serializers.py</code> - serializery pro validaci dat kurzů</li>
        <li><code>api/urls.py</code> - URL routing pro course endpoints</li>
        <li><code>tests/</code> - unit testy pro modely a API</li>
      </ul>
    </li>
    <li><strong>iis_wis2</strong> - hlavní Django projekt
      <ul>
        <li><code>settings.py</code> - konfigurace projektu, databáze, CORS, session</li>
        <li><code>urls.py</code> - hlavní URL routing</li>
      </ul>
    </li>
  </ul>

  <h3>Struktura Frontendu (React)</h3>
  <ul>
    <li><strong>src/main.ts</strong> - entrypoint aplikace</li>
    <li><strong>src/pages/</strong> - komponenty stránek odpovídající routám</li>
    <li><strong>src/components/</strong> - znovupoužitelné komponenty (Header, Footer, ErrorMessage, atd.)</li>
    <li><strong>src/queries/</strong> - Funkce pro definici stavu stránek, jejich načítání (fetching) a mutace</li>
    <li><strong>src/services/</strong> - API vrstva</li>
  </ul>

  <h3>Mapování případů použití na implementaci</h3>
  <p><em>Poznámka: Garant kurzu má automaticky práva lektora kurzu.</em></p>

  <h4>1. Registrace a autentizace uživatelů</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/auth/sign-up/ (<code>SignUpView</code>) - registrace nového uživatele</li>
    <li>POST /api/auth/login/ (<code>LoginView</code>) - přihlášení</li>
    <li>POST /api/auth/logout/ (<code>LogoutView</code>) - odhlášení</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/SignUpPage.tsx</code> (<code>/sign-up</code>)</li>
    <li><code>pages/LoginPage.tsx</code> (<code>/login</code>)</li>
    <li><code>services/api.ts</code></li>
  </ul>

  <h4>2. Editace profilu uživatele</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/auth/profile/ (<code>ProfileRetrieveView</code>) - zobrazení vlastního profilu</li>
    <li>PATCH /api/auth/user/profile/update (<code>ProfileUpdateView</code>) - úprava profilu</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/ProfilePage.tsx</code> (<code>/profile</code>)</li>
  </ul>

  <h4>3. Správa uživatelů a přehledy (Admin)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/auth/users/ (<code>UsersView</code>) - seznam všech uživatelů</li>
    <li>GET /api/auth/sessions/ (<code>SessionsView</code>) - přehled aktivních sessions</li>
    <li>POST /api/auth/users/:id/activate/ (<code>UserActivateView</code>) - aktivace uživatele</li>
    <li>POST /api/auth/users/:id/deactivate/ (<code>UserDeactivateView</code>) - deaktivace uživatele</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/UsersPage.tsx</code> (<code>/users</code>)</li>
    <li><code>pages/AdminPage.tsx</code> (<code>/admin</code>)</li>
  </ul>

  <h4>4. Procházení dostupných kurzů (Neregistrovaný a Registrovaný)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/guest/courses/ (<code>CoursesListAsGuestView</code>, <code>CourseDetailViewForGuests</code>)
      - veřejný přístup k schváleným kurzům
    </li>
    <li>GET /api/courses/user/courses/ (<code>CoursesListCreateView</code>, <code>CourseDetailView</code>) - přístup
      pro přihlášené uživatele</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CoursesPage.tsx</code> (<code>/courses</code>)</li>
    <li><code>pages/CourseDetailPage.tsx</code> (<code>/courses/:id</code>)</li>
  </ul>

  <h4>5. Založení kurzu (Registrovaný → Garant po schválení)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/user/courses/ (<code>CoursesListCreateView</code>) - vytvoření kurzu s parametry (typ, popis,
      kapacita, enrollment strategie)</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseNewCourse.tsx</code> (<code>/courses/create</code>)</li>
  </ul>
  <p><em>Po schválení administrátorem se uživatel stává garantem kurzu.</em></p>

  <h4>6. Zápis do kurzu (Registrovaný → Student po schválení)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/user/courses/:id/enroll/ (<code>CourseEnrollView</code>) - registrace do kurzu</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseDetailPage.tsx</code> (<code>/courses/:id</code>)</li>
  </ul>
  <p><em>Po registraci a schválení (automatickém nebo manuálním) se uživatel stává studentem kurzu.</em></p>

  <h4>7. Schvalování registrací studentů (Garant)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/courses/:id/students/ (<code>CourseStudentsView</code>) - seznam registrovaných
      studentů</li>
    <li>POST /api/courses/courses/:id/students/:student_id/approve/ (<code>StudentApproveView</code>) -
      schválení studenta
    </li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseStudentsPage.tsx</code> (<code>/courses/:id/students</code>)</li>
  </ul>
  <p><em>Garant může nastavit automatické potvrzování do limitu kurzu v parametrech kurzu.</em></p>

  <h4>8. Přidání lektora do kurzu (Garant)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/courses/:id/add-lector/ (<code>CourseAddLectorView</code>) - přiřazení lektora</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseDetailPage.tsx</code> (<code>/courses/:id</code>)</li>
  </ul>
  <p><em>Po přidání získává uživatel práva lektora pro daný kurz.</em></p>

  <h4>9. Nastavení termínů kurzu (Garant/Lector)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/courses/:id/terms/create/ (<code>TermCreateView</code>) - vytvoření termínu (typ,
      datum, čas, místnost, max. body)</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseCreateTerm.tsx</code> (<code>/courses/:id/create-term</code>)</li>
  </ul>

  <h4>10. Zobrazení rozvrhu (Student)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/user/schedule/ (<code>UserScheduleView</code>) - rozvrh na další 2 týdny</li>
    <li>GET /api/courses/user/schedule-filtered/ (<code>UserScheduleFilteredView</code>) - filtrovaný rozvrh</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/SchedulePage.tsx</code> (<code>/schedule</code>)</li>
  </ul>

  <h4>11. Hodnocení studentů (Lector)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/terms/:id/grades/ (<code>TermGradesView</code>) - přehled studentů a jejich hodnocení
    </li>
    <li>POST /api/courses/grade/ (<code>GradeCreateView</code>) - vytvoření hodnocení</li>
    <li>PATCH /api/courses/grade/:id/ (<code>GradeDetailView</code>) - úprava hodnocení</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/TermGradingPage.tsx</code> (<code>/courses/:id/terms/:termId/grading</code>)</li>
  </ul>

  <h4>12. Zadávání místností (Admin)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET/POST /api/courses/admin/locations/ (<code>LocationListCreateView</code>) - seznam a vytvoření místnosti
    </li>
    <li>GET/PATCH/DELETE /api/courses/admin/locations/:id/ (<code>LocationRetrieveUpdateDeleteView</code>) -
      úprava a mazání</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/LocationsPage.tsx</code> (<code>/locations</code>)</li>
  </ul>

  <h4>13. Schvalování kurzů (Admin)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/admin/courses/to_approve/ (<code>CoursesUnapprovedView</code>) - kurzy čekající na schválení
    </li>
    <li>POST /api/courses/admin/courses/:id/approve/ (<code>CourseApproveView</code>) - schválení kurzu</li>
    <li>POST /api/courses/admin/courses/:id/deny/ (<code>CourseDenyView</code>) - zamítnutí kurzu</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseApprove.tsx</code> (<code>/courses/to_approve</code>)</li>
  </ul>

  <h4>14. Přehled studia - osobní kurzy (Student/Lector/Garant)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/user/my-courses/ (<code>UserPersonalCoursesView</code>) - kurzy uživatele s vyznačením role
    </li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/MyCoursesPage.tsx</code> (<code>/my-courses</code>)</li>
  </ul>

  <h4>15. Registrace na termíny (Student)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/user/terms/:id/enroll/ (<code>TermEnrollView</code>) - zápis na konkrétní termín</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseTermsPage.tsx</code> (<code>/courses/:id/terms-list</code>)</li>
  </ul>
  <p><em>Student se může zapsat na termíny, pokud to termín vyžaduje (např. zkoušky).</em></p>

  <h4>16. Zobrazení termínů a hodnocení (Student)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/courses/:pk/terms/ (<code>CourseTermsView</code>) - seznam termínů kurzu</li>
    <li>GET /api/courses/user/terms/:id/ (<code>TermDetailView</code>) - detail termínu včetně vlastního
      hodnocení</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseTermsPage.tsx</code> (<code>/courses/:id/terms-list</code>)</li>
  </ul>
  <p><em>Student vidí své hodnocení pro jednotlivé termíny kurzu.</em></p>

  <h4>17. Ukončení kurzu (Garant)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>POST /api/courses/courses/:pk/finish/ (<code>FinishCourseView</code>) - ukončení kurzu s automatickým
      výpočtem výsledků</li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/CourseDetailPage.tsx</code> (<code>/courses/:id</code>)</li>
  </ul>

  <h4>18. Přehled nehodnocených termínů (Lector)</h4>
  <p><strong>Backend:</strong></p>
  <ul>
    <li>GET /api/courses/user/pending-grading/ (<code>PendingGradingView</code>) - termíny s nehodnocenými studenty
    </li>
  </ul>
  <p><strong>Frontend:</strong></p>
  <ul>
    <li><code>pages/PendingGradingPage.tsx</code> (<code>/pending-grading</code>)</li>
  </ul>

  <h3>Bezpečnost</h3>
  <ul>
    <li><strong>CSRF Protection:</strong> Django CSRF middleware + custom endpoint pro získání CSRF tokenu
      (<code>get_csrf_token</code>)</li>
    <li><strong>Session Management:</strong> Django session framework s automatickým odhlášením po nečinnosti</li>
    <li><strong>CORS:</strong> Django CORS headers s konfigurací pro povolené originy</li>
    <li><strong>Input Validation:</strong> Django REST Framework serializers s validací všech vstupů</li>
    <li><strong>Database Constraints:</strong> Unique constraints pro Student a Lector modely (prevence duplicit)</li>
  </ul>

  <h4>Ukládání hesel</h4>
  <p>Django poskytuje flexibilní systém pro ukládání hesel a ve výchozím nastavení používá PBKDF2. Helso se ukládá jako
    řetězec v následujícím formátu:</p>
  <code>&lt;algorithm&gt;$&lt;iterations&gt;$&lt;salt&gt;$&lt;hash&gt;</code>
  <p>Ve výchozím nastavení Django používá algoritmus PBKDF2 s hashem SHA256, což je mechanismus doporučený NIST. To by
    mělo být pro většinu uživatelů dostačující: je to velmi bezpečné a vyžaduje to obrovské množství výpočetního času k
    prolomení. <a href="https://docs.djangoproject.com/en/5.2/topics/auth/passwords/">Zdroj.</a></p>

  <h3>Databáze</h3>

  <img src="docs/erd.png" alt="ERD Diagram" style="max-width: 100%;" />

  <h2>Instalace</h2>

  <h3>Instalace na Render.com</h3>

  <p>Aplikace běží na Render.com. Frontend a Backend jsou oddělené služby. Deploy probíhá manuálně na render.com. Kód se
    stahuje z GitHubu. Stačí
    nastavit environment variables (příklady v deployment/) v administraci Renderu a je to.</p>

  <h3>Lokální instalace</h3>

  <p>Prerekvizity: python 3, npm, docker, docker-compose</p>

  <p>Postup instalace:</p>
  <ol>
    <li>`python -m venv .venv`</li>
    <li>`source .venv/bin/activate`</li>
    <li>`pip install -r requirements.txt`</li>
    <li>`chmod +x ./scripts/run_db.sh ./scripts/load_db.sh ./scripts/run_be.sh ./scripts/run_fe.sh`</li>
    <li>`./scripts/run_db.sh`</li>
    <li>`./scripts/load_db.sh`</li>
    <li>`./scripts/run_be.sh`</li>
    <li>V samostatném terminálu: `./scripts/run_fe.sh`</li>
  </ol>

  <h2>Známé problémy</h2>
  <p>Všechno funguje jak má. Žádné kritické chyby jsme nenašli.</p>

</body>