To get this project up and running please install the docker engine according to your OS.

To install the dependencies of the project, run npm run install:all in the root folder of the project.

All you need to do afterwards is running docker-compose up in the root folder of the project. The UI can then be found at http://localhost:3000 and the API at http://localhost:80.

The according src folders of the UI (./framework-ui/src) and the API (./framework-api/src) are mounted to their respective containers and file changes are being monitored so the according server will be restarted automatically with the changes and the UI also has hot reloading enabled.

The database can be populated with the OpenVM framework data, which is located in the competencies.js file. It holds the current state of the framework. This can be triggered via the /populate route. To purge the database GET the /deleteAll route. Be aware that on rebuilding the Database container changes to the database data will be lost. This is what the /populate route is for.

The API documentation can be found in ./api.postman_collection.json

The framework-ui-production container is purely for demo purposes.

This is licensed under MIT