Better navigation for HBO-I Domeinbeschrijving and Open-ICT Vaardigheden.
Full app built in NextJS version 13 with Material UI framework
Make sure to update all supported languages json's in/app/data
| Name | Example value | Type | Description |
|---|---|---|---|
| HOSTS | localhost, lef.open-ict.hu.nl | String | comma seperated list of all hosts that caddy should auto-generate https certificates and route for |
To run the application in a production environment run the following commands:
- Rename
.env-prodto.envand edit any values you need to edit. - Pull all the images with
docker compose pull, this prevents docker compose from seeing thebuild: ...section in the docker-compose.yml and deciding to build the image from source. Skip this step if you do wish to build from source. - Run the command
docker network create caddy - Launch Caddy with
docker compose -f docker-compose.caddy.yml --env-file .env up -d, you can optionally add the--no-buildafter the-dflag if you wish to tell docker compose to pull the images or use the local image cache instead of building the container from source. - Launch the application with
docker compose --env-file .env up -d
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes (Currently not implemented yet).
- Make sure your code lints.
- Issue that pull request and make sure to merge into the
devbranch!
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
By contributing, you agree that your contributions will be not be licensed and you lose all rights to your code.
The api is available under /api/v1
This application has an en and nl translation. The by default returns the nl translation for all requests. If you wish to get the en version then you must set the Accept-Language header with en as its value. It will currently respond with a 501 error because there are no translations yet. But this is something to keep in mind later.
This Accept-Language header applies for all api routes.
Getting an up to date version of the hbo-i.json file under /app/data
/api/v1/hboi
| Paramater | Possible values |
|---|---|
| architectuurlaag | Gebruikersinteractie | Organisatieprocessen |Infrastructuur | Software | Hardwareinterfacing |
| activiteit | Analyseren | Adviseren | Ontwerpen | Realiseren | Manage & Control |
| niveau | 1 | 2 | 3 | 4 |
{
error: message
}
{
[key: string]: {
[key: string] {
title: string,
info: string
}
}
}
Getting an up to date version of the vaardigheden.json file under /app/data
/api/v1/vaardigheden
{
error: message
}
{
[key: string]: {
[key: string] {
title: string,
info: string
}
}
}
Getting an up to date version of the vaardigheden.json file under /app/data
/api/v1/vaardigheden/{vaardigheid}
Possible vaardigheid values: 'Juiste kennis ontwikkelen', 'Kwalitatief product maken', 'Overzicht creëren', 'Kritisch oordelen', 'Samenwerken', 'Boodschap delen', 'Plannen', 'Flexibel opstellen', 'Pro-actief handelen', 'Reflecteren'
{
error: message
}
{
[key: string] {
title: string,
info: string
}
}