Repository files navigation

The Webcomponents of the Preben Norwegian Community software

These are the Webcomponents of the Preben Norwegian Community software. They are thewidgets that are used inside the LearnWorlds custom code to make the students interact with the APIs and handle their groups enrollments.

It was made withVue.js 2 andVuetify. The software interfaces withthe PNC APIs.

There is aDocker image that is automatically published with aGithub action. For the usage, the only other important related thing is the.env.example file that shows the parameters that must be configured.

To run it locally, just runnpm install for installing the dependencies,npm run serve to run a local server. To build the webcomponents, runnpm run build (the package.json script is changed to make it output the webcomponents).

It is also important knowing the branches organization:

• pre: it is a branch used just for development and can be modified without caring too much.Pushes must be done only on this branch.
• dev: it is a branch that has a github action to create and push theprebenorwegian/pnc-webcomponents-dev docker image on dockerhub.Merges must be done only from the pre branch.
• main: it is a branch that has a github action to create and push theprebenorwegian/pnc-webcomponents docker image on dockerhub.Merges must be done only from the dev branch.

Thetwo docker images (main and dev) exist because first ones wants totest the changes on dev andonly after pushing them in prod.