Readme update (badges + description)

.env

@@ -6,7 +6,7 @@
 # The shortcode for this component, should be a small set of letters reprecentint the application (use only letters, capitals and spaces)
 APP_NAME=education-component
 
-APP_NAME_TECHNCICAL=education-component
+APP_NAME_TECHNICAL=education-component
 
 
 # The description for this api

api/coverage.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1629203197">
-  <project timestamp="1629203197">
+<coverage generated="1629449800">
+  <project timestamp="1629449800">
     <file name="/srv/api/src/Controller/UserController.php">
       <class name="App\Controller\UserController" namespace="global">
         <metrics complexity="2" methods="2" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="2" coveredstatements="0" elements="4" coveredelements="0"/>
@@ -1079,63 +1079,63 @@
       <class name="App\Entity\Result" namespace="global">
         <metrics complexity="23" methods="20" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="36" coveredstatements="0" elements="56" coveredelements="0"/>
       </class>
-      <line num="131" type="method" name="__construct" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="133" type="stmt" count="0"/>
-      <line num="134" type="stmt" count="0"/>
-      <line num="136" type="method" name="getId" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="138" type="stmt" count="0"/>
-      <line num="141" type="method" name="setId" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="129" type="method" name="__construct" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="131" type="stmt" count="0"/>
+      <line num="132" type="stmt" count="0"/>
+      <line num="134" type="method" name="getId" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="136" type="stmt" count="0"/>
+      <line num="139" type="method" name="setId" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="141" type="stmt" count="0"/>
       <line num="143" type="stmt" count="0"/>
-      <line num="145" type="stmt" count="0"/>
-      <line num="148" type="method" name="getName" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="150" type="stmt" count="0"/>
-      <line num="153" type="method" name="setName" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="146" type="method" name="getName" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="148" type="stmt" count="0"/>
+      <line num="151" type="method" name="setName" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="153" type="stmt" count="0"/>
       <line num="155" type="stmt" count="0"/>
-      <line num="157" type="stmt" count="0"/>
-      <line num="160" type="method" name="getDescription" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="162" type="stmt" count="0"/>
-      <line num="165" type="method" name="setDescription" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="158" type="method" name="getDescription" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="160" type="stmt" count="0"/>
+      <line num="163" type="method" name="setDescription" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="165" type="stmt" count="0"/>
       <line num="167" type="stmt" count="0"/>
-      <line num="169" type="stmt" count="0"/>
-      <line num="172" type="method" name="getCompletionDate" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="174" type="stmt" count="0"/>
-      <line num="177" type="method" name="setCompletionDate" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="170" type="method" name="getCompletionDate" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="172" type="stmt" count="0"/>
+      <line num="175" type="method" name="setCompletionDate" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="177" type="stmt" count="0"/>
       <line num="179" type="stmt" count="0"/>
-      <line num="181" type="stmt" count="0"/>
-      <line num="184" type="method" name="getParticipant" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="186" type="stmt" count="0"/>
-      <line num="189" type="method" name="setParticipant" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="182" type="method" name="getParticipant" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="184" type="stmt" count="0"/>
+      <line num="187" type="method" name="setParticipant" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="189" type="stmt" count="0"/>
       <line num="191" type="stmt" count="0"/>
-      <line num="193" type="stmt" count="0"/>
-      <line num="196" type="method" name="getResource" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="198" type="stmt" count="0"/>
-      <line num="201" type="method" name="setResource" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="194" type="method" name="getResource" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="196" type="stmt" count="0"/>
+      <line num="199" type="method" name="setResource" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="201" type="stmt" count="0"/>
       <line num="203" type="stmt" count="0"/>
-      <line num="205" type="stmt" count="0"/>
-      <line num="211" type="method" name="getReviews" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="213" type="stmt" count="0"/>
-      <line num="216" type="method" name="addReview" visibility="public" complexity="2" crap="6" count="0"/>
+      <line num="209" type="method" name="getReviews" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="211" type="stmt" count="0"/>
+      <line num="214" type="method" name="addReview" visibility="public" complexity="2" crap="6" count="0"/>
+      <line num="216" type="stmt" count="0"/>
+      <line num="217" type="stmt" count="0"/>
       <line num="218" type="stmt" count="0"/>
-      <line num="219" type="stmt" count="0"/>
-      <line num="220" type="stmt" count="0"/>
-      <line num="223" type="stmt" count="0"/>
-      <line num="226" type="method" name="removeReview" visibility="public" complexity="3" crap="12" count="0"/>
-      <line num="228" type="stmt" count="0"/>
+      <line num="221" type="stmt" count="0"/>
+      <line num="224" type="method" name="removeReview" visibility="public" complexity="3" crap="12" count="0"/>
+      <line num="226" type="stmt" count="0"/>
+      <line num="227" type="stmt" count="0"/>
       <line num="229" type="stmt" count="0"/>
-      <line num="231" type="stmt" count="0"/>
-      <line num="232" type="stmt" count="0"/>
-      <line num="236" type="stmt" count="0"/>
-      <line num="239" type="method" name="getDateCreated" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="241" type="stmt" count="0"/>
-      <line num="244" type="method" name="setDateCreated" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="230" type="stmt" count="0"/>
+      <line num="234" type="stmt" count="0"/>
+      <line num="237" type="method" name="getDateCreated" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="239" type="stmt" count="0"/>
+      <line num="242" type="method" name="setDateCreated" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="244" type="stmt" count="0"/>
       <line num="246" type="stmt" count="0"/>
-      <line num="248" type="stmt" count="0"/>
-      <line num="251" type="method" name="getDateModified" visibility="public" complexity="1" crap="2" count="0"/>
-      <line num="253" type="stmt" count="0"/>
-      <line num="256" type="method" name="setDateModified" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="249" type="method" name="getDateModified" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="251" type="stmt" count="0"/>
+      <line num="254" type="method" name="setDateModified" visibility="public" complexity="1" crap="2" count="0"/>
+      <line num="256" type="stmt" count="0"/>
       <line num="258" type="stmt" count="0"/>
-      <line num="260" type="stmt" count="0"/>
-      <metrics loc="262" ncloc="167" classes="1" methods="20" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="36" coveredstatements="0" elements="56" coveredelements="0"/>
+      <metrics loc="260" ncloc="167" classes="1" methods="20" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="36" coveredstatements="0" elements="56" coveredelements="0"/>
     </file>
     <file name="/srv/api/src/Entity/Review.php">
       <class name="App\Entity\Review" namespace="global">
@@ -1492,6 +1492,6 @@
       <line num="20" type="stmt" count="0"/>
       <metrics loc="50" ncloc="17" classes="1" methods="1" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="2" coveredstatements="0" elements="3" coveredelements="0"/>
     </file>
-    <metrics files="27" loc="5343" ncloc="3403" classes="27" methods="362" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="968" coveredstatements="0" elements="1330" coveredelements="0"/>
+    <metrics files="27" loc="5341" ncloc="3403" classes="27" methods="362" coveredmethods="0" conditionals="0" coveredconditionals="0" statements="968" coveredstatements="0" elements="1330" coveredelements="0"/>
   </project>
 </coverage>

api/documentation/.env

@@ -6,7 +6,7 @@
 # The shortcode for this component, should be a small set of letters reprecentint the application (use only letters, capitals and spaces)
 APP_NAME=education-component
 
-APP_NAME_TECHNCICAL=education-component
+APP_NAME_TECHNICAL=education-component
 
 
 # The description for this api

api/documentation/README.md

@@ -0,0 +1,81 @@
+
+# education-component
+
+Description
+----
+
+
+Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.
+
+Additional Information
+----
+
+- [Contributing](CONTRIBUTING.md)
+- [ChangeLogs](CHANGELOG.md)
+- [RoadMap](ROADMAP.md)
+- [Security](SECURITY.md)
+- [Licence](LICENSE.md)
+
+
+Installation
+----
+We differentiate between two way's of installing this component, a local installation as part of the provided developers toolkit or an [helm](https://helm.sh/) installation on an development or production environment.
+
+#### Local installation
+First make sure you have [docker desktop](https://www.docker.com/products/docker-desktop) running on your computer. Then clone the repository to a directory on your local machine through a [git command](https://github.com/git-guides/git-clone) or [git kraken](https://www.gitkraken.com) (ui for git). If successful you can now navigate to the directory of your cloned repository in a command prompt and execute docker-compose up.
+```CLI
+$ docker-compose up
+```
+This will build the docker image and run the used containers and when seeing the log from the php container: "NOTICE: ready to handle connections", u are ready to view the documentation at localhost on your preferred browser.
+
+#### Instalation on Kubernetes or Haven
+As a haven compliant commonground component this component is installable on kubernetes trough helm. The helm files can be found in the api/helm folder. For installing this component trough helm simply open your (still) favorite command line interface and run
+```CLI
+$ helm install [name] ./api/helm --kubeconfig kubeconfig.yaml --namespace [name] --set settings.env=prod,settings.debug=0,settings.cache=1
+```
+For an in depth installation guide you can refer to the [installation guide](/api/helm) contained with the helm files, it also contains a short tutorial on getting your cluster ready to expose your installation to the world
+
+Standards
+----
+
+This component adheres to international, national and local standards (in that order), notable standards are:
+
+- Any applicable [W3C](https://www.w3.org) standard, including but not limited to [rest](https://www.w3.org/2001/sw/wiki/REST), [JSON-LD](https://www.w3.org/TR/json-ld11/) and [WEBSUB](https://www.w3.org/TR/websub/)
+- Any applicable [schema](https://schema.org/) standard
+- [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)
+- [GAIA-X](https://www.data-infrastructure.eu/GAIAX/Navigation/EN/Home/home.html)
+- [Publiccode](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/index.html), see the [publiccode](api/public/schema/publiccode.yaml) for further information
+- [Forum Stanaardisatie](https://www.forumstandaardisatie.nl/open-standaarden)
+- [NL API Strategie](https://docs.geostandaarden.nl/api/API-Strategie/)
+- [Common Ground Realisatieprincipes](https://componentencatalogus.commonground.nl/20190130_-_Common_Ground_-_Realisatieprincipes.pdf)
+- [Haven](https://haven.commonground.nl/docs/de-standaard)
+- [NLX](https://docs.nlx.io/understanding-the-basics/introduction)
+- [Standard for Public Code](https://standard.publiccode.net/), see the [compliancy scan](publiccode.md) for further information.
+
+This component is based on the following [schema.org](https://schema.org) sources:
+- [Address](https://schema.org/PostalAddress)
+- [Person](https://schema.org/Person)
+
+Developers toolkit and technical information
+----
+You can find the data model, OAS documentation and other helpfull developers material like a  postman collection under api/public/schema, development support is provided trough the [samenorganiseren slack channel](https://join.slack.com/t/samenorganiseren/shared_invite/zt-dex1d7sk-wy11sKYWCF0qQYjJHSMW5Q).
+
+Couple of quick tips when you start developing
+- If you not yet have setup the component locally read the Tutorial for setting up your local environment.
+- You can find the other components on [Github](https://github.com/ConductionNL).
+- Take a look at the [commonground componenten catalogus](https://componentencatalogus.commonground.nl/componenten?) to prevent development collitions.
+- Use [Commongroun.conduction.nl](https://commonground.conduction.nl/) for easy deployment of test environments to deploy your development to.
+- For information on how to work with the component you can refer to the tutorial [here](TUTORIAL.md).
+
+
+Contributing
+----
+First of al please read the [Contributing](CONTRIBUTING.md) guideline's ;)
+
+But most imporantly, welcome! We strife to keep an active community at [commonground.nl](https://commonground.nl/), please drop by and tell is what you are thinking about so that we can help you along.
+
+
+Credits
+----
+Information about the authors of this component can be found [here](AUTHORS.md)
+

api/helm/Chart.lock

@@ -6,4 +6,4 @@ dependencies:
   repository: https://charts.bitnami.com/bitnami
   version: 12.7.7
 digest: sha256:0d9618557ae25b2fe4b565d5f31feec7ca85904736971f970ad4cdb41215eb6e
-generated: "2021-08-17T12:24:20.6994478Z"
+generated: "2021-08-20T08:54:49.473844Z"

api/helm/index.yaml

@@ -5,7 +5,7 @@ entries:
       artifacthub.io/containsSecurityUpdates: "true"
     apiVersion: v2
     appVersion: V1.0
-    created: "2021-08-17T12:26:23.9832947Z"
+    created: "2021-08-20T08:56:23.8501528Z"
     dependencies:
     - condition: postgresql.enabled
       name: postgresql
@@ -17,7 +17,7 @@ entries:
       version: 12.7.7
     description: Naast deze JSON rest API is er ook een [graphql](/graphql) interface
       beschikbaar.
-    digest: 92f8e2d92ebd35293be596138ef0a32c084c3cd6a76c2bf6e7ca3895281c6a0c
+    digest: e7243b3669862f14ee543cf0c241ea8554eca03e8b4231df902edad502258a36
     home: https://www.conduction.nl
     icon: https://conductionnl.github.io/images/conduction_avatar_blue_on_transparant.svg
     keywords:
@@ -39,7 +39,7 @@ entries:
     version: 1.0.0
   - apiVersion: v1
     appVersion: V1.0
-    created: "2021-08-17T12:26:23.9735134Z"
+    created: "2021-08-20T08:56:23.8197055Z"
     description: Naast deze JSON rest API is er ook een [graphql](/graphql) interface
       beschikbaar.
     digest: 5d8f6efb8c51a5c4fd7353eb466100f17bbacc4941c12587073c707a81ba61b4
@@ -67,7 +67,7 @@ entries:
       category: Database
     apiVersion: v2
     appVersion: 11.10.0
-    created: "2021-08-17T12:26:23.9866321Z"
+    created: "2021-08-20T08:56:23.8535637Z"
     dependencies:
     - name: common
       repository: https://charts.bitnami.com/bitnami
@@ -101,7 +101,7 @@ entries:
       category: Database
     apiVersion: v2
     appVersion: 6.0.11
-    created: "2021-08-17T12:26:23.9916362Z"
+    created: "2021-08-20T08:56:23.9028882Z"
     dependencies:
     - name: common
       repository: https://charts.bitnami.com/bitnami
@@ -130,4 +130,4 @@ entries:
     urls:
     - charts/redis-12.7.7.tgz
     version: 12.7.7
-generated: "2021-08-17T12:26:23.9683084Z"
+generated: "2021-08-20T08:56:23.8000024Z"

api/helm/values.yaml

@@ -61,7 +61,7 @@ postgresql:
 ingress:
   enabled: false
   type: "nginx"
-  hostname: .local
+  hostname: education-component.local
   path: /
   annotations:
     # kubernetes.io/ingress.global-static-ip-name: chart-ip