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)
Discuss it in the Community Forum
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.
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
git clone https://github.com/sirixdb/sirix.git
git clone https://github.com/sirixdb/sirix-web-frontend.git
- Copy the
- Start Keyclock with the command
sudo docker-compose up waitforkeycloakfrom your sirixdb directory with the copied
- In your browser navigate to http://127.0.0.1:8080 and click on the link "Administration Console".
- Use username "admin", password "admin" to log in.
- Navigate to
Standard Flow Enabled.
- Set redirect URL to
- Navigate to the
Credentialstab and generate a new secret.
- Put this secret in
sirix/bundles/sirix-rest-api/src/main/resources/sirix-conf.jsonas the value for
client.secret. Make sure that the
oAuthFlowTypeis set to
- Create a user:
Add User=> Username admin. Under
Credentials=> New password => admin / admin. Set Temporary to off. Under
Role Mappingsadd the 4 roles:
- Start the SirixDB HTTP-Server with the command
sudo docker-compose up -d server
- Start the Node.js Server without Docker:
npm run dev
- 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
For detailed explanation on how things work, check out Nuxt.js docs.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!