Skip to content

Commit

Permalink
chore: Bump version to 0.1.13. Upgrade deps
Browse files Browse the repository at this point in the history
  • Loading branch information
vemonet committed Oct 3, 2024
1 parent c226007 commit 6010907
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 111 deletions.
18 changes: 17 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,22 @@ cd sparql-editor

> Requirement: [NodeJS](https://nodejs.org/en) installed.
Install dependencies:

```bash
npm i
```

Update dependencies to the latest available versions:
Upgrade dependencies to the latest available versions:

```bash
npm run upgrade
```

## 🛠️ Run in development

Run the `index.html` page in development with auto reload when change to the code:

```bash
npm run dev
```
Expand All @@ -35,8 +39,20 @@ Run the [demo pages](https://sib-swiss.github.io/sparql-editor) locally:
npm run demo
```

## 🧪 Run tests

Basic tests have been defined using `vitest`

```bash
npm test
```

## 🧹 Format and lint

> [!TIP]
>
> This will be done automatically when you commit through a pre-commit hook.
Auto format code with prettier:

```bash
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@

</div>

A standard web component to easily deploy a user-friendly SPARQL query editor for one or more endpoints. Built on the popular [YASGUI editor](https://github.com/zazuko/Yasgui), it provides context-aware autocomplete for classes and predicates based on the content of the endpoints.
A standard web component to easily deploy a user-friendly [SPARQL](https://www.w3.org/TR/sparql12-query/) query editor for one or more endpoints. Built on the popular [YASGUI editor](https://github.com/zazuko/Yasgui), it provides context-aware autocomplete for classes and predicates based on the content of the endpoints.

The editor retrieves metadata about the endpoints by directly querying them, so all that is needed is to generate and upload some metadata to each endpoints, and it works on top of any triplestore without configuration needed. Reducing the need for complex infrastructure, while making your SPARQL endpoints easier to query for users and machines.

- **Autocomplete possibilities for properties and classes** are automatically pulled from the endpoints based on [VoID description](https://www.w3.org/TR/void/) present in the triplestore (`void:linkPredicate|void:property` and `void:class`). The suggested properties are contextually filtered based on the class of the subject at the cursor's position, and are aware of `SERVICE` clauses, ensuring relevant autocompletion even in federated queries. Checkout the [`void-generator`](https://github.com/JervenBolleman/void-generator) project to automatically generate VoID description for your endpoint.
👆️ **Try it** with [SIB](https://www.sib.swiss/) endpoints, such as UniProt and Bgee, at **[sib-swiss.github.io/sparql-editor](https://sib-swiss.github.io/sparql-editor)**

- **✨ Autocomplete possibilities for properties and classes** are automatically pulled from the endpoints based on the [VoID description](https://www.w3.org/TR/void/) present in the triplestore. The suggested properties are contextually filtered based on the class of the subject at the cursor's position, and are aware of `SERVICE` clauses, ensuring relevant autocompletion even in federated queries 😎. Checkout the [`void-generator`](https://github.com/JervenBolleman/void-generator) project to automatically generate VoID description for your endpoint.

<details><summary>VoID description is retrieved with a SPARQL query.</summary>

Expand Down Expand Up @@ -42,7 +44,7 @@ The editor retrieves metadata about the endpoints by directly querying them, so

</details>

- **Example SPARQL queries** defined using the SHACL ontology are automatically pulled from the endpoint (queries are defined with `sh:select|sh:ask|sh:construct|sh:describe`, and their human readable description with `rdfs:comment`). Checkout the [`sparql-examples`](https://github.com/sib-swiss/sparql-examples) project for more details.
- **📜 Example SPARQL queries** defined using the SHACL ontology are automatically pulled from the endpoint (queries are defined with `sh:select|sh:ask|sh:construct|sh:describe`, and their human readable description with `rdfs:comment`). Checkout the [`sparql-examples`](https://github.com/sib-swiss/sparql-examples) project for more details.

<details><summary>The example queries are retrieved with a SPARQL query.</summary>

Expand All @@ -59,7 +61,7 @@ The editor retrieves metadata about the endpoints by directly querying them, so

</details>

- **Prefixes** are automatically pulled from the endpoint using their definition defined with the [SHACL ontology](https://www.w3.org/TR/shacl/) (`sh:prefix`/`sh:namespace`).
- **🏷️ Prefixes** are automatically pulled from the endpoint using their definition defined with the [SHACL ontology](https://www.w3.org/TR/shacl/) (`sh:prefix`/`sh:namespace`).

<details><summary>The prefixes/namespaces are retrieved with a SPARQL query.</summary>

Expand All @@ -72,8 +74,6 @@ The editor retrieves metadata about the endpoints by directly querying them, so

</details>

👆️ You can **try it** for a few SPARQL endpoints of the SIB, such as UniProt and Bgee, here: **[sib-swiss.github.io/sparql-editor](https://sib-swiss.github.io/sparql-editor)**

![Screenshot gene](demo/screenshot_gene.png)

---
Expand Down Expand Up @@ -185,7 +185,7 @@ npx http-server
python -m http.server
```

# 🧑‍💻 Contributing
## 🧑‍💻 Contributing

Checkout [CONTRIBUTING.md](https://github.com/sib-swiss/sparql-editor/blob/main/CONTRIBUTING.md) for more details on how to run this in development and make a contribution.

Expand Down
Loading

0 comments on commit 6010907

Please sign in to comment.