hanze/programmeerles-ouderen

readme.md in master
Repositories | Summary | Log | Files

readme.md (5639B) download


 1# PROGRAMMEERLES VOOR OUDEREN
 2
 3[Repository](https://github.com/MoiBaguette/Webtechnologie-Project)
 4
 5## De server runnen
 6
 7Dit is een dev-server, dus run je met `debug=True`-flag!
 8
 9*Als onze website zo goed is, om het in production te runnen, verwijder het `debug=True` :beers:*
10
11**Deze repository clonen:**
12```
13$ git clone https://github.com/MoiBaguette/Webtechnologie-Project
14```
15
16**Alle afhankelijkheden installeren:**
17```
18$ pip3 install flask wtforms flask_sqlalchemy flask-wtf email_validator flask-bcrypt flask-login pillow
19```
20
21**De server runnen:**
22```
23$ python run.py
24```
25
26
27## Uitleg
28
29### Bestanden
30
31| bestand               | route                       | beschrikbaar als<sup>1</sup> | beschrijving                                           |
32|-----------------------|-----------------------------|------------------------------|--------------------------------------------------------|
33| index.html            | /                           | gast                         | home-pagina                                            |
34| about.html            | /about                      | gast                         | over ons                                               |
35| register.html         | /register                   | gast                         | registeren van een gebruiker<sup>2</sup>               |
36| login.html            | /login                      | gast                         | inloggen van een gebruiker<sup>2,3</sup>               |
37|                       | /logout                     | klant                        | uitloggen van een gebruiker                            |
38| course_overview.html  | /courses                    | docent                       | lessen bewerken/verwijderen                            |
39| new_course.html       | /course/new                 | docent                       | nieuwe les aanmaken                                    |
40| course.html           | /course/`:course_id`        | klant                        | les informatie                                         |
41| new_course.html       | /course/`:course_id`/update | docent                       | les instellingen                                       |
42|                       | /course/`:course_id`/delete | docent                       | les verwijderen                                        |
43| admin.html            | /users                      | admin                        | gebruiker overzicht<sup>4</sup>                        |
44| account.html          | /user/self                  | klant                        | profiel instellingen                                   |
45| admin_user.html       | /user/`:user_id`            | admin                        | gebruiker instellingen                                 |
46|                       | /user/`:user_id`/delete     | admin                        | gebruiker verwijderen                                  |
47|                       | /user/`:user_id`/reset      | admin                        | gebruikers wachtwoord terugzetten<sup>5</sup>          |
48| index.html            | *not found*                 |                              | 404 page not found handler                             |
49| **overige bestanden** |                             |                              |                                                        |
50| forms.py              |                             |                              | alle forms voor de websites                            |
51| models.py             |                             |                              | alle database structs, om alle tabellen te beschrijven |
52| routes.py             |                             |                              | alle routen en endpoints                               |
53| server.py             |                             |                              | de server initialatie, database etc.                   |
54| site.db               |                             |                              | hoofd-database voor users, courses etc.                |
55| .gitignore            |                             |                              | om git te stoppen, \__pycache__ mee up te laden        |
56| run.py                |                             |                              | om de server te runnen                                 |
57| layout.html           |                             |                              | de basis layout voor alle routen                       |
58| static/main.css       |                             |                              | de basis stylesheet voor alle routen                   |
59| static/profile_pics   |                             |                              | map met alle profielfoto's                             |
60
61> <sup>1</sup> de hierachie is: gast (niet ingelogd), klant, docent, admin<br>
62> dus kan een gast het minste bereiken, een klant ook kan alles bereiken wat gast mag etc.
63
64> <sup>2</sup> als hij al ingelogd is, wordt weer naar `/` redirect
65
66> <sup>3</sup> jij kan een `?next=` parameters geven, dan wordt na het inloggen daarheen redirect
67
68> <sup>4</sup> bij gebruiker zoeken moet de naam overeinkomen met de gebruikers naam, nog geen echte zoek-functie
69
70> <sup>5</sup> betekent: zijn wachtwoord is dan gelijk aan zijn e-mail om in te loggen en zijn wachtwoord weer te veranderen, als iemand zijn wachtwoord is vergeten
71
72
73## Test Profielen
74
75| type    | e-mail            | password |
76|---------|-------------------|----------|
77| klant   | [email protected]     | `hallo`  |
78| docent  | [email protected]   | `hallo`  |
79| admin   | [email protected]    | `hallo`  |