Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
NoB0 committed May 7, 2024
1 parent a0deea0 commit 7e80fdd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/source/pkg_client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ To start PKG Client, run the following commands in the directory `pkg_client`:
npm install
npm start
Note that `npm install` only needs to be run once, unless the dependencies change. For more information on how to run the client, refer to the README in the `pkg_client` directory.
Note that `npm install` only needs to be run once, unless the dependencies change. For more information on how to run the client, refer to the `README <https://github.com/iai-group/pkg-api/blob/main/pkg_client/README.md>` in the `pkg_client` directory.

In case the server is not running on the default port (i.e., 5000), `PKG_API_BASE_URL` in `pkg_client/public/config.json` must be updated accordingly.

Features
--------

PKG Client provides the following features:
PKG Client has the following pages:

* **Login/Registration**: To access their PKG, users must be logged in. If they do not have an account, they can register.
* **Home**: The home page provides a text input field where users can enter their management instructions (i.e., add, remove, and retrieve statements) in natural language. After being processed by the server, the outcome of the instructions is displayed. The home page also provides a button to visualize the PKG.
* **Populate PKG**: Users can populate their PKG by adding or removing statements via a form. This feature assumes that the user is familiar with the `PKG vocabulary <https://iai-group.github.io/pkg-vocabulary/>`.
* **Explore PKG**: Users can visualize their PKG or a part of it as an RDF graph. The visualization is generated based on the results of a SPARQL query, hence, this feature is intended for advised users.
* **Explore PKG**: Users can visualize their PKG or a part of it as an RDF graph. The visualization is generated based on the results of a SPARQL query, hence, this feature is intended for advanced users.
2 changes: 1 addition & 1 deletion docs/source/pkg_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Routes
The server has four main routes that relate to the :doc:`features available <pkg_client>` in the PKG Client:

* `/auth`: Handles the authentication of users and service providers.
* `/nl`: Handles natural language instructions.
* `/nl`: Handles natural language instructions provided by users to manage the PKG.
* `/statements`: Manages the addition and deletion of statements via forms.
* `/explore`: Handles SPARQL queries for the visualization of the PKG.

0 comments on commit 7e80fdd

Please sign in to comment.