Skip to content

docs: Added fuseki local setup guide #20

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.

Sign up for GitHub

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

Open
chamathpali wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: Added fuseki local setup guide #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ IN - Instances
| UserIntent (SN) | `/api/onto/UserIntent` | <http://www.w3id.org/iSeeOnto/user#UserIntent> | Cockpit |
| KnowledgeLevel (IN) | `/api/onto/KnowledgeLevel` | <http://www.w3id.org/iSeeOnto/user#KnowledgeLevel> | Cockpit |

🚧 Ongoing Development 🚧

### Response Model

#### For Instances (IN)
Expand All @@ -55,8 +53,21 @@ IN - Instances
]
```

## Local Setup
### Fuseki Setup

- Download the Fuseki package https://jena.apache.org/documentation/fuseki2/#download-fuseki-with-ui
- Extract the zip
- Run Fuseki server within the extracted folder `./fuseki-server`
- Goto http://localhost:3030/#/
- Goto the manage tab (Screenshot below)
![image](https://github.com/chamathpali/iSeeOntoAPI/assets/5123109/a89feeaf-a684-4f29-9756-2204c63a44aa)
Here you can create a new dataset if its not existing
- Make sure to use the same name in the `.env` file update the `SPAQRL_ENDPOINT=http://localhost:3030/DATABASE_NAME_HERE/` e.g. `SPAQRL_ENDPOINT=http://localhost:3030/isee-dev/`
- Now you can use the OntoAPI, make sure to run the dump endpoint on the first run!

### Setup

### OntoAPI Setup

```
npm install
Expand All @@ -68,11 +79,12 @@ Create a .env file and change the `SPAQRL_ENDPOINT` connection string as require
npm start
```

## Docker Setup
#### Docker Setup

```
docker build -f Dockerfile -t isee4xai/ontoapi:dev .

docker-compose --file docker-compose.yml up -d --build
```