diff --git a/factual-consensus-finder/README.md b/factual-consensus-finder/README.md index c6c5ff0..390dfab 100755 --- a/factual-consensus-finder/README.md +++ b/factual-consensus-finder/README.md @@ -1,6 +1,52 @@ -# TODO -# Usage +# FactualConsensusFinder + +Prefusion([FlexiFusion](https://svn.aksw.org/papers/2019/ISWC_FlexiFusion/public.pdf)) based viewer for possible inconsensus in Wikipedia, Wikidata and "Your Data". + +## Usage + +> Prerequisites [node.js & npm](https://nodejs.org/en/) + (e.g Debian/Ubunutu `sudo apt-get install nodejs`) + +Install project dependencies with ``` npm install ``` + +Change application configuration in `config.js` + +``` +module.exports = { + expose_port: "9005", + + mongo_url: "mongodb://readonly:gfs@88.99.242.78:8989/prefusion", + database_name: "prefusion", + collection: "provenance", + + id_management: "https://global.dbpedia.org/same-thing/lookup/?uri=", + + default_subject: "https://global.dbpedia.org/id/4KKSo", + default_predicate: "http://www.w3.org/2000/01/rdf-schema#label" + + //DEPRECATED + preference: "wikidata.dbpedia.org,en.dbpedia.org,de.dbpedia.org,fr.dbpedia.org,nl.dbpedia.org,sv.dbpedia.org", +}; +``` + +Run + +``` +bin/www.js +``` + +and then visit [9005](http://localhost:9005) + + +## Routing + +| Route | Params | Description | +|---|---|---| +| / | ?s=IRI
?p=IRI | Lookup subject predicate pair | +| /raw | ?s=IRI
?p=IRI | Same as / but returns JSON | +| /label | ?s=IRI | Get rdfs:label for Resource | +