Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.13 KB

README.md

File metadata and controls

68 lines (43 loc) · 2.13 KB
Raw

Build Status GitHub license

AiiDA provenance explorer

This AngularJS application powers the EXPLORE section of the Materials Cloud at www.materialscloud.org/explore

Architecture

The app fetches configuration information from an endpoint returning a JSON file (example). The JSON object contains a list AiiDA REST API endpoints as well as some optional metadata.

The location of the JSON endpoint as well as the prefix for the AiiDA REST API endpoints is configured in Gruntfile.js.

Technologies

  • AngularJS
  • Bootstrap 3
  • SaSS
  • Bower, Grunt, Karma
  • UI Widget Toolkit: Vis.js, Kendo UI, Highchart, JSmol

Branches

  • develop: (default) The development branch
  • staging: Used for staging and production servers

Development setup

Note: The following works with node 14 but not 16! (Suggested setup: nvm install 14.)

Install dependencies:

npm install
npx bower install

Note: the project will not work if a 'profile list' is not accessible. Update Gruntfile.js to use the one of Materials Cloud:

sed -i 's/http:\/\/localhost/https:\/\/www.materialscloud.org/g' Gruntfile.js

Build with Grunt:

npx grunt build

Deploy:

cd dist
python -m http.server

Note: to access a local AiiDA REST API started with verdi restapi, there might be a CORS error occurring. For development, one can just disable CORS. E.g. in Chrome on linux: google-chrome --disable-web-security

License

MIT

Acknowledgements

This work is supported by the MARVEL National Centre of Competence in Research, the MaX European Centre of Excellence and by a number of other supporting projects, partners and institutions, listed on materialscloud.org.