This application connects to the Throughput annotation graph database. The database itself uses a data model based on the W3C Annotation standard, although modified to fit the graph database model we have developed, and further modified for several use-cases to fit with user interaction models.
This project is an open project, and contributions are welcome from anyone. All contributors to this project are bound by a code of conduct. Please review and follow this code of conduct as part of your contribution.
All products of the Throughput Annotation Project are licensed under and MIT License unless otherwise noted.
This repository uses a Vue.js application to serve a static website with integrations for the Throughput API.
This project requires the user to have node.js and npm installed on their local system. node.js downloads are available for multiple systems.
To initialize the project on your local computer (or on a remote server) first clone this repository to your machine. Then run the command:
npm installto install all required packages. Note that the user also requires a file called .env to be added to the local directory. This can be done using:
echo "VUE_APP_URLPATH=http://throughputdb.com/api" > .envecho "VUE_APP_ORCID={{ADD ORCID APP ID HERE}}" > .env.localDuring local development of the website it is useful to monitor the effect of changes locally.
npm run serve
Creates a local version of the website at localhost:8080.
This can be run to serve the vuejs webpage as a static "single page application".
npm run build
Once the script has been run the pages to serve the website are placed in the ./dist folder.
npm run test
Linting is a useful tool for software development to help ensure that code style is standardized, making it easier to detect code errors.
npm run lint