Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@propi
propi authored Feb 6, 2019
1 parent 0d1c56f commit 6244b29
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions gui/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# RdfRules: Graphical User Interface
# RDFRules: Graphical User Interface

The GUI for the RdfRules HTTP API is written as a HTML+JavaScript page which can be accessed from a browser. It offers simple interface to construct a mining pipeline, launch defined tasks and show a result, e.g., quads, rules, histograms, etc.
The GUI for the RDFRules HTTP API is written as a HTML+JavaScript page which can be accessed from a browser. It offers simple interface to construct a mining pipeline, launch defined tasks and show a result, e.g., quads, rules, histograms, etc.

## Getting Started

### Option 1: Existing RdfRules HTTP API + GUI
### Option 1: Existing RDFRules HTTP API + GUI

If you have launched the RdfRules HTTP API, then go to the "dist/webapp" directory and specify the endpoint variable. It should be an URL to the RdfRules HTTP API. After that, open "dist/webapp/index.html" with an internet browser and make a mining pipeline.
If you have launched the RDFRules HTTP API, then go to the `/dist/webapp` directory and specify the endpoint variable in the `index.html` file. It should be an URL to the RDFRules HTTP API. After that, open `/dist/webapp/index.html` with an internet browser and make a mining pipeline.

### Option 2: Run RdfRules HTTP API + GUI
### Option 2: Run RDFRules HTTP API + GUI

If you have not yet launched the RdfRules HTTP API, then go to the "dist/bin" directory and run the HTTP API by the "main" file (or "main.bat" for Windows). After that, open "dist/webapp/index.html" with an internet browser and make a mining pipeline.
If you have not yet launched the RDFRules HTTP API, then go to the `/dist/bin` directory and run the HTTP API by the `main` file (or `main.bat` for Windows). After that, open `/dist/webapp/index.html` with an internet browser and make a mining pipeline.

```
> cd dist/bin
Expand All @@ -22,7 +22,7 @@ or

In the "dist/bin" directory, there should be created a "workspace" directory where you can put datasets for analysis. Then, if you click on the "Load graph" or "Load dataset" operation, the content of the "workspace" directory is displayed and you can select datasets to be loaded.

### Option 3: Run RdfRules HTTP API + GUI in Docker
### Option 3: Run RDFRules HTTP API + GUI in Docker

```
> cd dist
Expand All @@ -40,6 +40,6 @@ You can copy datasets into the "workspace" directory in the running docker conta

## Documentation

The GUI of RdfRules is suitable for fast pipeline construction of any mining task. If you click on the plus symbol you can add an operation to your pipeline. Operations are divided into two categories: **transformations** and **actions**. Transformations transforms results of previous operations whereas actions are final operations which launch the whole pipeline with all defined transformations. Hence, each pipeline must end with just one action operation and may contain any number of transformations.
The GUI of RDFRules is suitable for fast pipeline construction of any mining task. If you click on the plus symbol you can add an operation to your pipeline. Operations are divided into two categories: **transformations** and **actions**. Transformations transforms results of previous operations whereas actions are final operations which launch the whole pipeline with all defined transformations. Hence, each pipeline must end with just one action operation and may contain any number of transformations.

The GUI is only facade of the [http](../http) module. For more details about individual operations see the [http](../http) folder.

0 comments on commit 6244b29

Please sign in to comment.