dubesar / sirix-web-frontend

A web frontend for SirixDB based on Nuxt.js/Vue.js, D3.js and Typescript

Join us on Slack | Community Forum

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

SirixDB Web frontend - An Evolutionary, Versioned, Temporal NoSQL Document Store

Store and query revisions of your data efficiently

"Remember that you're lucky, even if you don't think you are, because there's always something that you can be thankful for." - Esther Grace Earl (http://tswgo.org)

Introduction

Discuss it in the Community Forum

This is the repository for a web frontend based on Vue.js, D3.js and TypeScript.

It'll provide several interaction possibilities to store, update and query databases in SirixDB. Furthermore the front-end will provide interactive visualizations for exploring and comparing revisions of resources stored in SirixDB based on different views.

Test and edit in Gitpod

test and edit this project in a web based VS code environment.

Project setup

We currently have the following issue: sirixdb#18

For setting up the HTTP-Server together with a Keycloak-Server, have a look into the documentation for the REST-API.

You could also use docker-compose.

1. git clone https://github.com/sirixdb/sirix.git
2. run docker-compose up -d from the REST-API Bundle
3. import our test Keycloak realm configuration JSON file in the Keycloak Web-UI

For setting up the web frontend:

# install dependencies
$ npm run install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

Customize configuration

For detailed explanation on how things work, check out Nuxt.js docs.