Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated instructions for running GraphDB visualization #67

Merged
merged 2 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,16 @@ jobs:
strategy:
matrix:
# Available OS's: https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners

# Comment out MacOS, as it's very slow at the moment, and not really
# critical.
# os: [ubuntu-20.04, windows-2019, macos-10.15]
os: [ubuntu-20.04, windows-2019]
node-version: [18.x, 16.x]
os: [ubuntu-latest, windows-latest]
node-version: [20.x, 18.x]
steps:
- uses: actions/checkout@v2.3.4
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2.1.5
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Cache node modules
uses: actions/cache@v2.1.5
uses: actions/cache@v3
env:
cache-name: cache-node-modules
with:
Expand All @@ -43,13 +39,13 @@ jobs:
- run: npm test
- run: npx package-check
- name: Archive code coverage results
uses: actions/upload-artifact@v2.2.3
uses: actions/upload-artifact@v4
continue-on-error: true
with:
name: code-coverage-report
path: coverage
- name: Archive production artifacts
uses: actions/upload-artifact@v2.2.3
uses: actions/upload-artifact@v4
continue-on-error: true
with:
name: dist
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ docs/dist/
docs/.DS_Store
.env*.local
.cache

# Ignore IntelliJ IDE files...
.idea/
*.iml
34 changes: 16 additions & 18 deletions docs/VisualizePodData/VisualizePodData.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ yourself.

## Install Free triplestore on your own machine:

- Go to `https://www.ontotext.com/products/graphdb/graphdb-free/` and register.
(Within a few minutes you should receive a confirmation email with a link to
download and install the triplestore (make sure to keep an eye on your Trash
or Spam folder!)).
- Go to `https://www.ontotext.com/products/graphdb/graphdb-free/` and register
(there’s no longer any need to use a real email address - see the next step!).

- In the confirmation email, select the option to "_Run GraphDB as a desktop
installation_" for your operating system.
- You can wait for the confirmation email and follow the instructions to
”_Run GraphDB as a desktop installation_", or just register using any email
address and then simply click on the relevant operating system under the
“_GraphDB Download Links_“ section to install GraphDB immediately!.

## Run GraphDB

Expand All @@ -29,31 +29,29 @@ To create a new empty repository:

- From the main menu (on the left-hand-side), select "Setup | Repositories".
- Click the "_Create new repository_" button.
- Select the "_GraphDB Free_" option.
- Select the first "_GraphDB Repository_" option.
- Provide any name (without spaces!) for the "_Repository ID_" field, e.g.,
"inrupt-example".
"Inrupt-SamplePod".
- Click the "_Create_" button at the bottom of the page.

## Load example Pod data:

- From the main menu (on the left-hand-side), select "_Import | RDF_".
- From the main menu (on the left-hand-side), select "_Import_".
- Connect to the repository you’ve just created.
- Select "_Get RDF data from a URL_".
- Cut-and-paste the URL of our example data file:
`https://pod.inrupt.com/pattestburner1/public/PodPat.trig`
- Select the middle option, "_Get RDF data from a URL_".
- Enter the URL of our example Pod data file:
`https://storage.inrupt.com/6441a53f-01c5-478b-b701-52a8797ba988/public/PodPat.trig`
(or import the local file: [../../resources/test/PodPat.trig](../../resources/test/PodPat.trig))
- Click on the "_Import_" button to the right of the filename.
- Just click the "_Import_" button (i.e., there's no need to enter or change
anything).
- Click on the "_Import_".

## Visualize and interact with the Pod data yourself!

- From the main menu (on the left-hand-side), select "_Explore | Visual graph_".
- In the top "_Easy graph_" section, simply copy-and-paste this URL:
`https://pat.best-pod-provider.com/profile/card#me`
- ...and click the "_Show_" button
- Now try double-clicking on the nodes to expand them and explore (see a sample
expanded view [here](./VisualizeExamplePodData.png)).
- **_Now try double-clicking on the nodes to expand them and explore (see a sample
expanded view [here](./VisualizeExamplePodData.png))._**

# UI Navigation Tips

Expand All @@ -63,7 +61,7 @@ To create a new empty repository:
- Hovering over a node pops up a nice icon menu (from which you can remove the
node (just from the visualization, not the database!), etc.), but these icons
only appear if the sidebar is dismissed (so single click the node to dismiss
the sidebar first if needed).
the sidebar first, if needed).
- To ‘restart’ the visualization (e.g., if things get cluttered or confusing),
simply use <Ctrl>-R to refresh and start navigating again.
- Note that the sidebar only displays properties whose values are literals, not
Expand Down
Loading