OpenVM Framework Directory Application
To get this project up and running please install the docker engine according to your OS. On Linux install build-essentials to allow native compile of several npm tools.
To install the dependencies of the project, run
npm run install:all in the root folder of the project.
Starting the Application
The UI and API
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 API can server the UI as well, if you copy (after build) the framework-ui/build folder into the framework-api/src/build folder. This is useful in case you want to open only one port to outside (or proxy it).
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
/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
framework-ui-production container is purely for demo purposes.
This is licensed under MIT