Project-bestanden TI: Climate Measuring Box (CMB)

.gitlab-ci.yml

@@ -0,0 +1,21 @@
+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
+
+variables:
+  GIT_SUBMODULE_STRATEGY: recursive

README.md

@@ -0,0 +1,39 @@
+# 🌍 Climate Measuring Box
+
+Als student Technische Informatica ga je voor je project van blok 1 aan de slag met het maken van jouw eigen 'Climate Measuring Box' (CMB). De volledige omschrijving kan je vinden in de 'Wiki' van dit project (Plan > Wiki).
+
+## 📁 Project structuur
+
+In de bestanden van dit project vind je de volgende mappen:
+
+- `docs`: Hierin kan je de documentatie kwijt voor jouw project. Hiervan wordt een website gegenereerd die je kan vinden onder 'Pages' (Deploy > Pages).
+- `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.
+
+Dan vind je in dit project ook jouw User Stories, Learning Stories en de daarbij horende 'boards' (Plan > Issue boards).
+
+## 🔧 Configureren
+
+Om onderstaande stappen uit te voeren is het belangrijk dat je gebruik maakt van de Knowledgebase. Hier kan je zelf informatie vinden over de verschillende onderwerpen die je nodig hebt voor dit project. 
+
+1. Installeer op je eigen computer Git en Visual Studio Code.
+2. Volg de instructies in de Knowledgebase om dit project te 'clonen' naar jouw eigen computer.
+    - Tip: Kies een goede locatie op je computer waar je jouw project terug kan vinden.
+3. Open Visual Studio Code en klik in het menu op 'Open folder..', kies vervolgens je project map die je hebt gecloned bij stap 2.
+4. Via het menu kies je nu voor 'Terminal' en vervolgens 'New Terminal'. In dit venster kan je nu commando's uitvoeren.
+    - Voer het volgende commando uit: `git submodule add https://uva-hva.gitlab.host/hbo-ict/mdocotion.git mdocotion`
+    - Dan: `git commit -m "Added mdocotion submodule"`
+    - Vervolgens `git push`.
+5. Je kan nu de website van jouw project bekijken door naar de 'Pages' (Deploy > Pages) te gaan.
+
+## 🧰 Technieken
+
+In dit project ga je aan de slag met verschillende technieken.
+
+Embedded systeem:
+- [Arduino (C++)](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/hardware_interfacing/realiseren/verwerking/esp32-s3-devkitc-1/)
+
+Webapplicatie:
+- [HTML](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratieve_talen/html/)
+- [CSS](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/talen/declaratieve_talen/css/)
+- [Javascript](https://knowledgebase.hbo-ict-hva.nl/1_beroepstaken/software/realiseren/basis_principes/0_basis_principes/)

arduino/hello-world/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
+}

docs/index.md

@@ -0,0 +1,3 @@
+# Welkom
+
+Welkom op jouw Portfolio-website! Hier kan je met de wereld delen wat jij allemaal kan en wat je hebt gedaan.

mkdocs.yml

@@ -0,0 +1,32 @@
+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/
+    features:
+        - navigation.sections
+        - content.tabs.link
+
+plugins:
+    - search
+    - mermaid2
+    - awesome-pages
+    - mkdocs-video
+    - section-index
+    - autolinks
+    - macros:
+          modules: [mkdocs_macros_mdocotion]
+
+markdown_extensions:
+    - attr_list
+    - md_in_html
+    - fenced_code
+    - pymdownx.highlight:
+          linenums: true
+          use_pygments: true
+    - pymdownx.inlinehilite
+    - pymdownx.snippets
+    - pymdownx.superfences

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