Skip to content
A web frontend for SirixDB based on Nuxt.js/Vue.js, D3.js and Typescript
JavaScript Vue TypeScript CSS Dockerfile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update nodejs.yml Oct 24, 2019
.vscode change tasks shell Oct 10, 2019
assets initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
components Minor layout changes Oct 11, 2019
layouts initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
middleware initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
mock OAuth2 stuff not working Oct 22, 2019
models initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
pages Update index.vue Nov 17, 2019
plugins Add redirect to Keycloak and back Nov 16, 2019
services initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
static
store Add redirect to Keycloak and back Nov 16, 2019
types Add redirect to Keycloak and back Nov 16, 2019
.all-contributorsrc docs: update .all-contributorsrc Oct 29, 2019
.babelrc initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
.dockerignore Create .dockerignore Oct 27, 2019
.gitignore initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
Dockerfile Create Dockerfile Nov 15, 2019
README.md
app.container.ts initial setup for switching to nuxt for sirix-web-frontend Oct 6, 2019
axios.js Use axios from Nuxt.js Oct 23, 2019
docker-compose.yml Update docker-compose.yml Oct 28, 2019
jest.config.js
jsconfig.json
nuxt.config.js Add most recent changes Nov 16, 2019
package-lock.json Add redirect to Keycloak and back Nov 16, 2019
package.json Add redirect to Keycloak and back Nov 16, 2019
sirix-conf.json Create sirix-conf.json Oct 27, 2019
tsconfig.json Use axios from Nuxt.js Oct 23, 2019

README.md

PRs Welcome All Contributors

Tweet

Follow

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 and another tutorial: How YOU can contribute to OSS, a beginners guide

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.

Some ideas for comparing revisions of the XML or JSON resources, which need to be ported from a Java GUI/Processing can be found in my Master's Theses and in a Screencast.

Test and edit in Gitpod

Edit and test in Gitpod

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

Project setup

We currently face the following issue, whereas this workaround works until Nuxt.js or Element-UI fix the issue

We've created a Dockerfile and a docker-compose.yml file to simplify the setup process. However you still have to setup Keycloak as desribed in the documentation for the REST-API (especially assigning the roles to an admin-user):

In order to use docker-compose:

  1. mkdir sirixdb
  2. git clone https://github.com/sirixdb/sirix.git
  3. git clone https://github.com/sirixdb/sirix-web-frontend.git
  4. Copy the docker-compose.yml file from sirix-web-frontend to your sirixdb parent folder.
  5. Start Keyclock with the command sudo docker-compose up waitforkeycloak from your sirixdb directory with the copied docker-compose.yml file.
  6. In your browser navigate to http://127.0.0.1:8080 and click on the link "Administration Console".
  7. Use username "admin", password "admin" to log in.
  8. Navigate to Clients => sirix.
  9. Set Standard Flow Enabled.
  10. Set redirect URL to http://localhost:3005/callback.
  11. Navigate to the Credentials tab and generate a new secret.
  12. Put this secret in sirix/bundles/sirix-rest-api/src/main/resources/sirix-conf.json as the value for client.secret. Make sure that the oAuthFlowType is set to AUTH_CODE
  13. Create a user: Users => Add User => Username admin. Under Credentials => New password => admin / admin. Set Temporary to off. Under Role Mappings add the 4 roles: create, delete, modify, view.
  14. Start the SirixDB HTTP-Server with the command sudo docker-compose up -d server
  15. Start the Node.js Server without Docker: npm run dev
  16. In your browser call http://localhost:3005 and the frontend should appear.

Without Docker for setting up the web frontend:

# install dependencies
$ npm run install

# serve with hot reload at localhost:3005
$ 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.

Contributors

Thanks goes to these wonderful people (emoji key):

Simon Holdorf
Simon Holdorf

💻
yang
yang

💻
Atman
Atman

💻
Jawahar
Jawahar

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.