Package Exports

@matdata/yasgui
@matdata/yasgui/build/yasgui.min.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@matdata/yasgui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

YASGUI

Yet Another SPARQL GUI (YASGUI) is a powerful, user-friendly web-based interface for querying and exploring RDF data using SPARQL. It combines a feature-rich query editor (YASQE) with a versatile results viewer (YASR) to provide a comprehensive SPARQL IDE.

🌐 Try it now: https://yasgui.matdata.eu/

Quick Links

📖 User Guide - Complete guide for end users
🛠️ Developer Guide - API reference and integration guide
🚀 Production Environment - Live instance
📦 npm Package
🐳 Docker Hub
📝 Releases & Changelog
💻 GitHub Repository

Documentation

The documentation for YASGUI is hosted on GitHub Pages:

📚 Documentation Website: https://yasgui-doc.matdata.eu/
- User Guide, Developer Guide, API Reference
- Built with Docusaurus
- Version-tagged with the repository
🚀 Development Build: https://yasgui-doc.matdata.eu/dev/main/
- Live build from the main branch
- Updated automatically with every commit
- Test latest features before release

The documentation is version-tagged with the repository, ensuring consistency between code and documentation across releases.

Features

YASGUI provides a complete SPARQL development environment with powerful features:

✏️ Advanced Query Editor

SPARQL Syntax Highlighting - Color-coded SPARQL with error detection
Smart Autocomplete - Context-aware suggestions for keywords, prefixes, and URIs
Query Formatting - One-click query beautification with configurable formatters
Prefix Management - Auto-capture and reuse PREFIX declarations
URI Explorer - Ctrl+Click URIs to explore connections
Keyboard Shortcuts - Efficient query development workflow

📊 Powerful Visualizations

Table Plugin - Sortable, filterable, paginated result tables
Graph Plugin - Interactive RDF graph visualization
Geo Plugin - Geographic data on interactive maps
Response Plugin - Raw response viewer with syntax highlighting
Boolean Plugin - Visual true/false indicators for ASK queries
Error Plugin - Detailed error diagnostics

🎨 Themes & Layouts

Light & Dark Themes - Seamless theme switching with persistent preferences
Flexible Layouts - Vertical or horizontal editor/results arrangement

🔧 Expert Features

Multiple Tabs - Work on multiple queries simultaneously
Endpoint Management - Quick-switch between SPARQL endpoints
Persistent Storage - Auto-save queries and preferences
URL Sharing - Share queries via URL parameters
Fullscreen Mode - Maximize editor or results viewer
Export Results - Download results in various formats

For detailed feature documentation, see the User Guide.

Installation

npm

npm install @matdata/yasgui

Yarn

yarn add @matdata/yasgui

CDN

<link rel="stylesheet" href="https://unpkg.com/@matdata/yasgui/build/yasgui.min.css" />
<script src="https://unpkg.com/@matdata/yasgui/build/yasgui.min.js"></script>

Docker

docker pull mathiasvda/yasgui:latest
docker run -p 8080:8080 mathiasvda/yasgui:latest

Custom endpoint:

docker run -p 8080:8080 -e YASGUI_DEFAULT_ENDPOINT=https://your-endpoint.com/sparql mathiasvda/yasgui:latest

For detailed installation instructions and usage examples, see the Developer Guide.

Quick Start

Basic HTML Usage

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://unpkg.com/@matdata/yasgui/build/yasgui.min.css" />
</head>
<body>
  <div id="yasgui"></div>
  
  <script src="https://unpkg.com/@matdata/yasgui/build/yasgui.min.js"></script>
  <script>
    const yasgui = new Yasgui(document.getElementById("yasgui"), {
      requestConfig: {
        endpoint: "https://dbpedia.org/sparql"
      }
    });
  </script>
</body>
</html>

ES Modules / React / Vue / Angular

import Yasgui from '@matdata/yasgui';
import '@matdata/yasgui/build/yasgui.min.css';

const yasgui = new Yasgui(document.getElementById('yasgui'), {
  requestConfig: {
    endpoint: 'https://query.wikidata.org/sparql'
  },
  theme: 'dark',
  orientation: 'horizontal'
});

For framework-specific examples and advanced usage, see the Developer Guide.

Contributing

We welcome contributions! To get started:

Fork the repository
Clone and install: npm install
Run dev server: npm run dev
Make your changes
Run tests: npm test
Submit a pull request

For detailed contribution guidelines, see the Developer Guide.

License

MIT License - see LICENSE file for details.

This is a fork from Zazuko who forked it from Triply.

Release Notes & Changelog

Release notes and changelog are available in the Releases section.

For instructions on writing release notes, see release_notes_instructions.md