commit 5f4395e3dc63fa11da79c77420975d66a9447148 Author: HBO-ICT Bot Date: Tue Feb 6 16:21:12 2024 +0100 Project-bestanden van TI blok 3 gekopieerd diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3a0cc45 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,25 @@ +image: python:3.9-slim + +before_script: + - time apt update + - time pip install -r requirements.txt + - time cd mdocotion && python setup.py install && cd .. + +pages: + stage: deploy + tags: + - hva + script: + - time mkdocs build --site-dir public + artifacts: + paths: + - public + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + changes: + - "docs/**/*" + - "mkdocs.yml" + - ".gitmodules" + +variables: + GIT_SUBMODULE_STRATEGY: recursive \ No newline at end of file diff --git a/.gitlab/issue_templates/Learning Story.md b/.gitlab/issue_templates/Learning Story.md new file mode 100644 index 0000000..4b3b562 --- /dev/null +++ b/.gitlab/issue_templates/Learning Story.md @@ -0,0 +1,21 @@ +``` +Inleiding van de learning story: +Vul hier een korte beschrijving in van de learning story. +Probeer dit direct te koppelen aan het project wat studenten gaan doen. +``` + +**Wat ga ik leren?** + +``` +Zet hier een overzicht van de vaardigheden die een student gaat leren. +Als de student alle vinkjes heeft afgevinkt, dan hebben ze dit onderwerp goed begrepen. +``` + +- [ ] <- Maak op deze manier afvinklijstjes + +**Hoe ga ik dit leren?** + +``` +Zet hier de bronnenlijst. +``` +- [ ] <- Maak op deze manier afvinklijstjes \ No newline at end of file diff --git a/.gitlab/issue_templates/User Story.md b/.gitlab/issue_templates/User Story.md new file mode 100644 index 0000000..a087776 --- /dev/null +++ b/.gitlab/issue_templates/User Story.md @@ -0,0 +1,32 @@ +Als gebruiker wil ik ..., zodat ... (verwijder deze regel, plaats de tekst in de titel) + + +[beschrijving van de user story en context] + +**Taken** + +Deze user story is opgedeeld in een aantal taken. Vul onderstaande lijst zelf aan. + +- [ ] Taak 1. +- [ ] Taak 2. +- [ ] ... + +**Acceptatie criteria** + +Acceptatie criteria zijn specifieke eisen waaraan de User Story moet voldoen. Deze zijn meestal uniek per User Story. + +- [ ] Acceptatiecriterium 1 +- [ ] Acceptatiecriterium 2 +- [ ] ... + +**Definition of Done** + +- [ ] Alle acceptatiecriteria van de user story zijn afgevinkt. +- [ ] Je hebt volgens de HBO-ICT werkstandaarden gewerkt (Agile, GitLab, sprint boards, sprint planning, HBO-ICT conventions etc.) +- [ ] Het werk is technisch gedocumenteerd in het Engels en relevant voor collega-ontwikkelaars. Denk o.a. aan ERD, UML, testen en testresultaten. +- [ ] Het leerproces is beschreven in Standaardnederlands. +- [ ] Het werk is gereviewd door een peer. +- [ ] Het UX/UI gedeelte van de applicatie voldoet aan het Think-Make-Check (TMC) principe. +- [ ] De code is functioneel getest op fouten. +- [ ] De code werkt zonder fouten bij normaal gebruik. +- [ ] De webapplicatie dient zowel op mobiele- als desktop-apparaten gebruikt te kunnen worden. \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..1656e15 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# 🏢 Optimalisatie Studieomgeving (OSO) + +De opdracht van Technische Informatica (TI) bestaat uit het ontwikkelen van een systeem wat gaat zorgen voor een optimalisatie van de studieomgeving. + +Aan dit project werk je in een groep, waarbij je onze Gitlab omgeving gebruikt voor het bijhouden van je code, documentatie en planning (projectmanagement). + +## 📁 Bestandsstructuur + +In deze repository krijgen jullie een structuur aan bestanden, hierbij mag je zelf wijzigingen maken in de bestanden die je nodig hebt. +De structuur is als volgt: + +- `docs`: Hierin kan je de documentatie kwijt voor jouw project. Hiervan wordt een website gegenereerd die je kan vinden onder 'Pages' (Deploy > Pages). +- `teamdocumentatie`: In deze map kan je (markdown!) documenten kwijt die gaan over de samenwerking in het team, wat je niet op je gegenereerde website wilt hebben. +- `arduino`: Hierin kan je de code kwijt voor jouw project wat te maken heeft met je embedded systeem, code geschreven in Arduino. +- `web`: Hierin kan je de code kwijt voor jouw project wat te maken heeft met de webapplicatie, bijvoorbeeld HTML, CSS en Javascript. +- `server`: Hier kan je je server applicatie kwijt die gaat zorgen voor de verbinding tussen jouw embedded systeem, web-applicatie en database. + +## 📝 Opdracht + +De opdracht vinden jullie in de map `docs` onder `opdracht.md`. Hierin staat de opdracht beschreven en de eisen waaraan je moet voldoen. Beter is om de opdracht te bekijken via `Deploy` > `Pages`, en vervolgens te navigeren naar de opdracht. + +Daarnaast vind je in dit Gitlab-project: + +- User Stories (Plan > Issues) +- Learning Stories (Plan > Issues) +- Scrum Board (Plan > Boards) +- Sprints (Plan > Milestones) + +## 📚 Documentatie + +Naast het schrijven van commentaar in je code ga je ook aan de slag met het schrijven van documentatie. Dit doe je door in de map `docs` een Markdown bestand aan te maken. Dit bestand wordt automatisch omgezet naar een website die je kan vinden onder 'Pages' (Deploy > Pages). \ No newline at end of file diff --git a/arduino/hello-world.ino b/arduino/hello-world.ino new file mode 100644 index 0000000..6c158b2 --- /dev/null +++ b/arduino/hello-world.ino @@ -0,0 +1,16 @@ +/* + * Description: This is a basic sketch about blinking an LED on your ESP32. + * Author: Mats Otten + * Date: 5 september 2023 + */ + +void setup() { + pinMode(LED_BUILTIN, OUTPUT); +} + +void loop() { + digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level) + delay(1000); // wait for a second + digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW + delay(1000); // wait for a second +} diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000..0738ad5 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,8 @@ +nav: + - 🏚️ Home: index.md + - 🧰 Opdracht: + - Planning: opdracht/planning + - Omschrijving: opdracht/omschrijving + - Criteria: opdracht/criteria + - User Stories: opdracht/user_stories + - Links: opdracht/links \ No newline at end of file diff --git a/docs/assets/office-building.svg b/docs/assets/office-building.svg new file mode 100644 index 0000000..34324f5 --- /dev/null +++ b/docs/assets/office-building.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..27f65a3 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +# TI Portfolio Website + +Welkom op jullie portfolio website! Hier kunnen jullie documentatie kwijt +die jullie gaan schrijven voor jullie project. + +Maak je pagina's vooral leuk door [plaatjes](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/1_markdown_basics/#afbeeldingen), [video's](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/videos/) en [diagrammen](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/mermaid_diagrammen/) toe te voegen; dit kan allemaal in [markdown](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/0_markdown/)! + +{{ mdocotion_header('https://images.unsplash.com/photo-1498050108023-c5249f4df085?q=80&w=2072&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D') }} diff --git a/docs/opdracht/criteria.md b/docs/opdracht/criteria.md new file mode 100644 index 0000000..411642f --- /dev/null +++ b/docs/opdracht/criteria.md @@ -0,0 +1,71 @@ +# Criteria + +Net als de opdracht van blok 1 en blok 2, is ook deze opdracht opgedeeld in een aantal criteria. Deze criteria zijn opgedeeld in kwaliteitscriteria en gedragscriteria. De kwaliteitscriteria zijn de criteria die je project moet bevatten, de gedragscriteria zijn de criteria die je gedrag beschrijven. + +## Kwaliteitscriteria + +Voor het bouwen van deze opdracht heb je 3 sprints de tijd. Aan het einde van die periode moet je applicatie aan een aantal verwachtingen voldoen. We noemen dit de kwaliteitscriteria. Voor dit blok zien de kwaliteitscriteria er als volgt uit: + +| Nr | Kwaliteitscriteria | HBO-i model | +|----|--------------------|-------------| +| K1 | Je ontwerpt, realiseert en beheert object georiënteerde software applicatie die samenwerkt met een database. | S-O, S-R, S-MC | +| K2 | Je verzamelt, ontwerpt en realiseert de wensen en behoeften van de gebruiker in prototype. | G-A, G-O, G-R | +| K3 | Je ontwerpt, realiseert en beheert een infrastructuur volgens de gegeven specificaties. | I-O, I-R, I-MC | +| K4 | Je ontwerpt software voor een intelligente controller voorzien van actuatoren en sensoren. | H-O | +| K5 | Je realiseert software voor een intelligente controller voorzien van actuatoren en sensoren. | H-R | + +## Gedragscriteria + +Om een IT-project succesvol op te leveren, is het noodzakelijk dat je leert om je als een professional te gedragen. Je hebt hiervoor vaardigheden nodig, die we binnen het hbo professional skills noemen. Voor dit project dient je gedrag aan de volgende criteria te voldoen: + +| Nr | Gedragscriteria | HBO-i model | +|----|-----------------|-------------| +| G1 | Je ontwikkelt je op persoonlijk vlak en blijft leren. | PL-O, PL-PO | +| G2 | Je werkt constructief samen in een team. | DI-C, DI-S | +| G3 | Je werkt planmatig en volgens gegeven aanpak aan een project. | TO-I, TO-M | + +## HBO-I +_Binnen deze opdracht ligt de focus op de volgende beroepstaken:_ +### K1. OOP & database +- Software ontwerpen (S-O) : niveau 1 +- Software realiseren (S-R) : niveau 1 +- Software manage & control (S-MC) : niveau 1 + +### K2. User Experience Design +- Gebruikersinteractie analyseren (G-A) : niveau 1 +- Gebruikersinteractie ontwerpen (G-O) : niveau 1 +- Gebruikersinteractie realiseren (G-R) : niveau 1 + +### K3. Infrastructuur +- Infrastructuur ontwerpen (I-O): niveau 1 +- Infrastructuur realiseren (I-R): niveau 1 +- Infrastructuur manage & control (I-MC): niveau 1 + +### K4. Software Ontwerpen Intelligente Controller +- Hardwareinterfacing - Ontwerpen (H-O): niveau 1 + +### K.5 Software Schrijven Intelligente Controller +- Hardwareinterfacing - Realiseren (H-R): niveau 1 + + +_Binnen deze opdracht ligt de focus op de volgende professional skills:_ +### G1 Ontwikellen +- Persoonlijk leiderschap (PL) : + - Ondernemend zijn (PL-O) : niveau 1 + - Persoonlijke ontwikkeling (PL-PO): niveau 1 + +### G2 Samenwerken +- Doelgericht interacteren (DI) + - Communiceren (DI-C) : niveau 1 + - Samenwerken (DI-S): niveau 1 + +### G3 Planmatig werken +- Toekomstgericht organiseren (TO) + - Managen (TO-M) : niveau 1 + - Ethiek (TO-E) : niveau 1 + + + + + +{{ mdocotion_header('https://images.unsplash.com/photo-1484480974693-6ca0a78fb36b?q=80&w=2072&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D') }} diff --git a/docs/opdracht/links.md b/docs/opdracht/links.md new file mode 100644 index 0000000..8ce22a5 --- /dev/null +++ b/docs/opdracht/links.md @@ -0,0 +1,34 @@ +# Links + +Op deze pagina vind je een overzicht van handige links die van pas kunnen komen bij het maken van de opdracht. + +## Project management + +- [Knowledgebase: Git](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/manage_and_control/git/0_git/) + - Bij een project waar je te maken hebt met teamgenoten is het goed gebruik maken van Git alleen maar belangrijker. + +## Programmeren + +- [Knowledgebase: HTML](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratieve_talen/html/) +- [Knowledgebase: CSS](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratieve_talen/css/) +- [Knowledgebase: Basis principes](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/basis_principes/0_basis_principes/) + +## Libraries + +- [Arduino: ArduinoJSON](https://arduinojson.org/) +- [Arduino: WebSockets](https://www.arduino.cc/reference/en/libraries/websockets/) +- [Python: Websockets](https://websockets.readthedocs.io/en/stable/intro/index.html) +- [MQTT](https://mqtt.org/) + +## Backend + +- [Python: Flask](https://flask.palletsprojects.com) +- [Knowledgebase: Node.js](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/platformen/nodejs/) met [Express](https://expressjs.com/) +- [PHP: Laravel](https://laravel.com/) + +## Overige + +- [Localtunnel](https://theboroer.github.io/localtunnel-www/) + - Wanneer je een server draait op het netwerk van de HvA mag je niet zomaar van buitenaf verbinding maken. Met localtunnel kun je een tunnel maken naar een publieke URL. Zo kun je toch van buitenaf verbinding maken met je server. +- [Oege](https://oege.ie.hva.nl/) + - Oege is onze eigen cloud omgeving waar jij als HBO-ICT student een MySQL database kan krijgen en SSH toegang tot een Linux server. \ No newline at end of file diff --git a/docs/opdracht/omschrijving.md b/docs/opdracht/omschrijving.md new file mode 100644 index 0000000..994dad0 --- /dev/null +++ b/docs/opdracht/omschrijving.md @@ -0,0 +1,68 @@ +# Opdracht omschrijving + +Dit is het project voor Technische Informatica in blok 3, in het studiejaar 2023 - 2024. In het eerste blok heb je gewerkt aan je eigen Climate Measuring Box (CMB), in het tweede blok heb je gewerkt aan je eigen Game (console) met controller, dit blok is het alweer tijd voor het derde project. + +## Optimalisatie Studieomgeving (OSO) + +Er zijn veel bedrijven of instellingen die te maken hebben met (kantoor)panden waar soms wel duizenden mensen per dag over de vloer komen. Denk bijvoorbeeld aan een vliegveld als Schiphol, een ziekenhuis zoals het AMC of een school, zoals de Hogeschool van Amsterdam, welke meerdere gebouwen heeft. + +Als beheerder van zo'n gebouw wil je natuurlijk dat de mensen die er werken of studeren zich prettig voelen, dat kan je zorgen voor de veiligheid en dat je inzicht krijgt in hoe het gebouw gebruikt wordt. Het Wibauthuis is het gebouw waar jullie systeem voor ontworpen wordt. Het Facility Management van het Wibauthuis zal de gebruiker van jullie systeem zijn. + +## Opdracht + +De opdracht is om een systeem te ontwerpen en te bouwen waarmee je inzicht krijgt in hoe het Wibauthuis gebruikt wordt. Je kan hierbij denken aan de volgende zaken: + +- Hoeveel mensen zijn er in het gebouw? +- Hoeveel mensen zijn er in een bepaalde ruimte? +- Hoeveel werkplekken zijn er bezet? +- Hoe leefbaar is het binnenklimaat in een bepaalde ruimte? +- Waar zijn bepaalde spullen te vinden in het gebouw? +- Welke recycle-stations worden het meest gebruikt? +- Je mag ook zelf een [vraag](https://knowledgebase.hbo-ict-hva.nl/2_professional_skills/onderzoekend_probleemoplossen/probleemaanpak/onderzoeksvraag/) bedenken die je wilt beantwoorden. + +## Eisen + +Om jullie project af te bakenen hebben we een aantal eisen opgesteld: + +### Waarom? (K2) + +- Begin met het stellen van een goede vraag. Welk probleem wil je oplossen? Wat wil je bereiken met je systeem? Voor wie is het bedoeld? Wat is de toegevoegde waarde van je systeem? Gebruik de geboden [technieken](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/gebruikers_interactie/analyseren/0_gi_analyseren/) om tot een goede vraag te komen. + +### Data verzamelen (K1, K3, K4) + +- Informatie wordt verzameld door sensoren, die op verschillende ruimtes in het gebouw worden geplaatst. +- De sensoren moeten communiceren met een centraal punt. +- De data wordt gestructureerd opgeslagen in een MySQL database met meerdere tabellen. ([ERD](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/ontwerpen/relationele_databases/erd/), [EERD](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/ontwerpen/relationele_databases/eerd/), [Normaliseren](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/ontwerpen/relationele_databases/normaliseren/)) + +### Data verwerken (K1) + +- De data wordt verwerkt door een systeem, dat de data analyseert en nuttige informatie eruit haalt. +- Het systeem verwerkt gegevens via 'Edge computing', hiervoor stellen wij een Raspberry Pi beschikbaar per team. Deze Raspberry Pi is verbonden met het netwerk van de HvA en kan dus communiceren met de sensoren. +- Alle services (database, webserver, etc.) draaien op de Raspberry Pi. + +### Configuratie en visualisatie (K1, K2, K3) + +- Het systeem kan via een webapplicatie geconfigureerd worden. +- De status van de sensoren kan realtime worden weergegeven via deze webapplicatie. +- De webapplicatie kan de opgeslagen data visualiseren. +- Engels is de voertaal van de webapplicatie. + +### Documentatie (K1, K2m K3, G1, G2, G3) + +- Je gebruikt afbeeldingen, [ERD](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/ontwerpen/relationele_databases/erd/)'s, [UML](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/ontwerpen/uml/0_uml/)'s, etc. om je systeem te documenteren. + - Diagrammen zijn bij voorkeur gemaakt met [mermaid.js](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/mermaid_diagrammen/) +- Alle afbeeldingen en diagrammen zijn voorzien van begeleidende tekst. +- Alle documentatie wordt opgeleverd in [markdown](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratief/markdown/0_markdown/) formaat. + +!!! tip "`/docs` en `/teamdocumentatie`" + + Alle markdown documentatie in de `/docs` map wordt automatisch omgezet naar een website. De documentatie in de `teamdocumentatie` map wordt niet omgezet naar een website. Gebruik de `teamdocumentatie` map om documentatie te maken die niet voor de opdrachtgever bedoeld is. + +#### Stijl + +- Vermijd het gebruik van de woorden "ik" en "wij" in de documentatie. +- Schrijf de documentatie in het Engels +- Volg de aanwijzingen in de [Stijlgids taal](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/basisvaardigheden/taalvaardigheden/stijlgids_taal/) +- Voeg [bronvermeldingen](https://knowledgebase.hbo-ict-hva.nl/2_professional_skills/onderzoekend_probleemoplossen/onderzoeken/brongebruik/) toe aan je documentatie + +{{ mdocotion_header('https://images.unsplash.com/photo-1586892477838-2b96e85e0f96?q=80&w=2059&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D') }} \ No newline at end of file diff --git a/docs/opdracht/planning.md b/docs/opdracht/planning.md new file mode 100644 index 0000000..f315f04 --- /dev/null +++ b/docs/opdracht/planning.md @@ -0,0 +1,19 @@ +# Planning + +Het project opgedeeld in 3 sprints. + +| Week | Datum | Activiteit(en) | +|---------|-----------------|-------------------------------------------| +| Week 1 | 5 feb - 9 feb | Start Sprint 1 | +| Week 2 | 12 feb - 16 feb | Sprint 1 - Sprint Review & retrospective | +| Week 3 | 19 feb - 23 feb | Roostervrije week | +| Week 4 | 26 feb - 1 maa | Start Sprint 2 | +| Week 5 | 4 maa - 8 maa | | +| Week 6 | 11 maa - 15 maa | Sprint 2 - Sprint Review & retrospective | +| Week 7 | 18 maa - 22 maa | Start Sprint 3 | +| Week 8 | 25 maa - 29 maa | | +| Week 9 | 1 apr - 5 apr | Sprint 3 - Sprint Review & retrospective | +| Week 10 | 8 apr - 12 apr | Alternatief programma | + + +{{ mdocotion_header('https://images.unsplash.com/photo-1506784983877-45594efa4cbe?q=80&w=1168&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D') }} diff --git a/docs/opdracht/user_stories.md b/docs/opdracht/user_stories.md new file mode 100644 index 0000000..9e4d034 --- /dev/null +++ b/docs/opdracht/user_stories.md @@ -0,0 +1,38 @@ +# User Stories + +Om te weten wat de klant wil, is het belangrijk om de wensen van de klant te vertalen naar user stories. Een user story is een korte beschrijving van een functie, geschreven vanuit het perspectief van de gebruiker. Het is een manier om de wensen van de klant te vertalen naar een concrete opdracht. + +Meer informatie over User Stories vind je in onze [Knowledgebase: User Stories](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/gebruikers_interactie/analyseren/user_story/). + +Zorg ervoor dat elke User Story een goede titel, beschrijving, acceptatie criteria en definition of done heeft. + +## Acceptatiecriteria + +Acceptatiecriteria zijn de voorwaarden waaraan een user story moet voldoen om door de klant geaccepteerd te worden. Ze geven dus aan wanneer een user story klaar is en wanneer deze opgeleverd kan worden. Acceptatiecriteria zijn een soort checklist die je kunt afvinken als je de user story hebt afgerond. + +Een voorbeeld van acceptatiecriteria is: + +- De gebruiker kan de voornaam in het profiel wijzigen. +- De gebruiker kan de achternaam in het profiel wijzigen. +- De gebruiker kan het e-mailadres in het profiel wijzigen. +- De gebruiker kan het wachtwoord in het profiel wijzigen. +- De gebruiker kan het profiel opslaan. +- De gebruiker kan niet de geboortedatum in het profiel wijzigen. + +## Definition of Done + +Binnen scrum dient iedere user story te voldoen aan een zogenaamde Definition of Done (DoD). Door het opstellen en aanhouden van een Definition Of Done, zorg je ervoor dat het werk wat je aflevert ook daadwerkelijk gebruikt kan worden. + +Als je een user story hebt afgebouwd zet je 'm in _verify_ en controleer je of deze voldoet aan de _Definition of Done_ (zie hieronder). Pas als dat in orde is kun je de user story op _Done_ zetten. + +Voor dit project gebruik je de volgende Definition of Done: + +- Alle acceptatiecriteria van de betreffende user story zijn afgevinkt. +- Je hebt volgens de HBO-ICT werkstandaarden gewerkt (Agile, GitLab, sprint boards, sprint planning, HBO-ICT conventions etc.) +- Het werk is technisch gedocumenteerd in het Engels en relevant voor collega-ontwikkelaars. Denk o.a. aan ERD, UML, testen en testresultaten. +- Het leerproces is beschreven in Standaardnederlands. +- Het werk is gereviewd door een peer. +- Het UX/UI gedeelte van de applicatie voldoet aan het Think-Make-Check (TMC) principe. +- De code is functioneel getest op fouten. +- De code werkt zonder fouten bij normaal gebruik. + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..21451b1 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,47 @@ +site_name: TI Portfolio +site_description: HBO-ICT Technische Informatica Portfolio +site_author: HBO-ICT +copyright: Copyright 2023 Hogeschool van Amsterdam + +theme: + name: material + custom_dir: mdocotion/ + logo: assets/office-building.svg + favicon: assets/office-building.svg + features: + - navigation.sections + - content.tabs.link + +plugins: + - search + - mermaid2 + - awesome-pages + - mkdocs-video: + css_style: + is_video: True + min-width: "640px" + max-width: "900px" + min-height: "360px" + - section-index + - autolinks + - macros: + modules: [mkdocs_macros_mdocotion] + +markdown_extensions: + - attr_list + - admonition + - md_in_html + - fenced_code + - pymdownx.highlight: + linenums: true + use_pygments: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - toc: + permalink: true + - pymdownx.details diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3e34e5f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,10 @@ +mkdocs ~= 1.4.0 +Jinja2==3.1.0 +mkdocs-material ~= 9.1.12 +mkdocs-video ~= 1.3 +mkdocs-mermaid2-plugin ~= 0.6.0 +mkdocs-macros-plugin ~= 0.7.0 +mkdocs-awesome-pages-plugin ~= 2.8.0 +mkdocs-autolinks-plugin ~= 0.6.0 +mkdocs-section-index ~= 0.3.5 +gitpython ~= 3.1.27 \ No newline at end of file diff --git a/server/.gitkeep b/server/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/teamdocumentatie/README.md b/teamdocumentatie/README.md new file mode 100644 index 0000000..c553091 --- /dev/null +++ b/teamdocumentatie/README.md @@ -0,0 +1,10 @@ +# Teamdocumentatie + +Documenten die niet voor publiekelijke consumptie zijn, maar wel gedeeld moeten worden binnen het team kunnen hier geplaatst worden. Denk hierbij aan: + +- Notulen van vergaderingen +- Afspraken binnen het team +- Afspraken met de opdrachtgever +- Afspraken met de begeleider +- Processen binnen het team +- ... \ No newline at end of file diff --git a/web/.gitkeep b/web/.gitkeep new file mode 100644 index 0000000..e69de29