/munidiff.github.io

Primary LanguageJavaScript

Munidiff timeline client

This is a web-based client that allows exploring the history of models stored in a GitHub repository.

The explorer can be accessed in this website: https://munidiff.github.io/

How to use

  1. Provide a URL to a GitHub commit. You can pre-load the explorer with an example URL by using this link.

  2. After providing a URL, hit the search icon on the right of the search bar. A list of commits should appear on the left, with the details of the commit from the URL appearing below the search bar, including a list of changed models.

  3. Click on any of the changed models to see the difference reports below. It might take a while to appear, as the Google Cloud Functions starts and answer the query.

  4. The graphical and textual reports should appear.

  5. You can click any of the commit messages on the left to change the focus to that commit, and repeat the process.

How to develop

Both this frontend and the explorer's backend can be run locally for development purposes.

Run the backend locally (optional)

The backend of this explorer is based on the modiff model comparison tool. This backend is currently deployed online, but it can be ran locally to speed up development:

Steps:

  1. Checkout the backend's repository.
  2. Run mvn function:run from a terminal.
  3. To instruct the frontend to use the local service, modify the useLocalBackend property at the js/config.js file from this repository:
  useLocalBackend: true,

Run the frontend locally

  1. After checking out the code, run npm install.
  2. Run a web server and watch for changes with npm run serve (uses webpack, details in package.json)
  3. A web browser tab should have opened at localhost:9000