Skip to content
This repository was archived by the owner on Dec 14, 2021. It is now read-only.

Commit 6b762e9

Browse files
committed
Add quick start guide.
Closes #1.
1 parent 2a12189 commit 6b762e9

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# Solid-TPF
2-
A [Triple Pattern Fragments](https://www.hydra-cg.com/spec/latest/triple-pattern-fragments/) interface to a [Solid](https://solid.mit.edu/) server.
2+
3+
This is a quick research prototype of how to build a query interface
4+
([Triple Pattern Fragments](https://www.hydra-cg.com/spec/latest/triple-pattern-fragments/))
5+
on top of a [Solid](https://solid.mit.edu/) server.
6+
7+
This query interface will respect WebID authentication,
8+
and only return triples that the logged in user is allowed to see.
9+
10+
## Quick start guide
11+
Disclaimer: this is a prototype, no guarantee it will (still) work.
12+
13+
- This prototype takes a file system for Solid as input, and assumes full read access to it.
14+
- First, an index of all data needs to be created, by running `bin/solid-to-tpf`. This index contains all triples, per solid pod and per permissioned user.
15+
- The `feature/datasource` branch contains a data source for the [Linked Data Fragments server](https://github.com/LinkedDataFragments/Server.js).
16+
- Configure a Linked Data Fragments server (version 3) to use this data source.
17+
- Configure a node-solid-server to act as an auth proxy to the Linked Data Fragments server.
18+
- The Linked Data Fragments server will then receive the logged in user, and will return the corresponding triples through a Triple Pattern Fragments interface.
19+
- Use a Linked Data Fragments query client to issue SPARQL queries over one or multiple data sources.

0 commit comments

Comments
 (0)