simplod

Visualization tool for simplifying access to Linked Data.

Further documentation with examples can be found on GitHub Pages.

Requirements

Node version > 10

Supported browsers: Google Chrome, Mozilla Firefox, Safari

Local development

Install the dependencies via npm i
Run the local environment by npm run start:dev or npm run start:dev:https to use SSL
- The application is now accessible on http(s)://localhost:3000
- The server listens to changes to the codebase, and if any are detected, reloads the application.
OPTIONAL - Add localhost to your trusted apps

If you wish to use a Solid Pod while running the application locally, you have to add the hosting address to your Solid Pod. This can be done automatically through signing to the Solid Pod in the upper right corner

Production deployment

Since this application is created with Create React App, you can follow the deployment manual directly, or follow the steps below:

Install dependencies: npm install
Get production build: npm run build
Publish the build folder and make index.html accessible
You can utilize the following parameters in the URL for the application to present different data on user's access
- schemaURL= - URL of the data schema to be loaded in the application
- endpointURL= - URL of the endpoint to be used
- modelURL= - URL of the file to be loaded, works the same way as File → Load → By URI
  - Overrides both schemaURL and endpointURL
Example https://jaresan.github.io/simplod/build/index.html?schemaURL=https%3A%2F%2Fjaresan.github.io%2Fsimplod%2Fexamples%2Fnobel_prizes.ttl&endpointURL=http%3A%2F%2Fdata.nobelprize.org%2Fstore%2Fsparql

SPARQL Proxy

If the SPARQL endpoint isn't hosted on the same domain as the application, the requests might fail due to CORS or Same-origin policy. To prevent that, you can use the Express proxy and set up the linked YASGUI tool to use it.

The only steps you need to take to achieve that are as follows:

Deploy the proxy
Change const root = 'https://simplod.herokuapp.com'; in @@constants/api.js to point to your proxy

Code documentation

Documentation generated from the code annotations is available on GitHub Pages.

mff-uk / simplod