https://github.com/sage-org/sage-web
📰 Generate interactive Web interfaces for SaGe servers
https://github.com/sage-org/sage-web
html-generator rdf sage-server sparql static-site-generator web
Last synced: 5 months ago
JSON representation
📰 Generate interactive Web interfaces for SaGe servers
- Host: GitHub
- URL: https://github.com/sage-org/sage-web
- Owner: sage-org
- License: mit
- Created: 2019-06-04T11:49:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T18:28:05.000Z (over 3 years ago)
- Last Synced: 2025-10-20T03:03:40.297Z (8 months ago)
- Topics: html-generator, rdf, sage-server, sparql, static-site-generator, web
- Language: HTML
- Homepage:
- Size: 322 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sage-web
[](https://travis-ci.com/sage-org/sage-web)
Generate an interactive Web interface for a SaGe SPARQL query server, similar to the one available at [http://sage.univ-nantes.fr](http://sage.univ-nantes.fr).
# Installation
**Requirements**: [Node.js](https://nodejs.org/en/) v8.11 or higher
```bash
npm install -g sage-web
```
# Usage
Use the `sage-web` CLI program to generate an interactive website for a SaGe server.
It is divided into *two subcommands*, which both takes as first arguments the URL of the SaGe server.
* The `sage-web serve -p ` command start the website using a local HTTP server on the given port.
* The `sage-web compile -o ` command compile the website as static HTML into the output directory.
Additionnaly, the `save-web help ` command can be used to display the help for the subcommand `cmd`.
For example, `sage-web serve http://soyez-sage.univ-nantes.fr -p 8000` launch an interactive website, similar to the one available at [http://sage.univ-nantes.fr](http://sage.univ-nantes.fr), which can be accessed at [http://localhost:800](http://localhost:800).
## Help for `sage-web`
```
Usage: sage-web [options] [command]
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
serve Start a Web server to serve the SaGe interactive website
compile Compile the SaGe interactive website as a static HTML website
help [cmd] Display help for [cmd]
```
## Help for `sage-web serve`
```
Usage: sage-web serve
Start a Web server to serve the SaGe interactive website
Options:
-p, --port Port on which the server should listen (default: 3000)
-h, --help Output usage information
```
## Help for `sage-web compile`
```
Usage: sage-web compile
Compile the SaGe interactive website as static HTML
Options:
-o, --output Output directory (default: "./build")
-h, --help Output usage information
```
# Manual Installation
**Requirements**:
* [Node.js](https://nodejs.org/en/) v8.11 or higher
* [yarn](https://yarnpkg.com/) v1.21 or higher
```bash
git clone https://github.com/sage-org/sage-web.git
cd sage-web
yarn install
```