README.md

Project Setup - Setting up SirixDB locally

Unfortunately, this is currently a bit messy, but still rather straightforward.

There are several resources required to run SirixDB, and they can all be found in the resource directory of this repository.

SirixDB depends on keycloak for authentication, so we first need to run (in the directory in which you have the above resources):

docker-compose up -d keycloak

It can take about a minute for keycloak to be ready for connections. If you like, you can use the wait.sh script in the above mentioned resources folder to wait until keycloak is ready. The docker-compose file runs a script from the resources folder to initialize keycloak with a user "admin" with the password "admin".

Once keycloak is ready, run:

docker-compose up -d server

The Sirix database is now ready for use.

Developing

Before developing, run npm run build:tailwind. This command should also be run after running the build or export NPM scripts.

Developing in the browser

1. Start the sapper server: npm run dev.
2. In your browser navigate to http://localhost:3000.

Develop with Tauri

You need to follow the tauri setup guide first. Note that the NPM tauri package is included in the dependencies of this project. This is not yet configured to work on all platforms, however.

1. run npm run dev.
2. in another terminal, run npm run tauri dev.

To build with Tauri

1. run npm run export.
2. run tauri build.