Skip to content

openVirtualMobility/competency-directory

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 65 commits ahead of JonathanStoye:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

OpenVM Framework Directory Application

Installation

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

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.

Development

The UI and API

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 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

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.

API Documentation

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

Appendix

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

License

This is licensed under MIT

About

A prototype of an Application to manage the OpenVM Competency and Skill Framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.0%
  • HTML 2.2%
  • Other 0.8%