Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sirixdb/sirix-svelte-frontend
A GUI console for SirixDB, using Svelte/Sapper.
https://github.com/sirixdb/sirix-svelte-frontend
database-gui hacktoberfest javascript sapper sirixdb svelte tauri typescript
Last synced: 2 months ago
JSON representation
A GUI console for SirixDB, using Svelte/Sapper.
- Host: GitHub
- URL: https://github.com/sirixdb/sirix-svelte-frontend
- Owner: sirixdb
- License: apache-2.0
- Created: 2020-02-13T18:12:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-25T17:35:19.000Z (over 1 year ago)
- Last Synced: 2024-08-01T00:12:42.839Z (6 months ago)
- Topics: database-gui, hacktoberfest, javascript, sapper, sirixdb, svelte, tauri, typescript
- Language: Svelte
- Homepage:
- Size: 4.19 MB
- Stars: 26
- Watchers: 4
- Forks: 5
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-for-beginners - SirixDB - end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java. (JavaScript)
- fucking-awesome-for-beginners - SirixDB - end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java. (JavaScript)
README
## 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 `resources` 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):
```bash
docker-compose up -d keycloak
```
It can take a minute for keycloak to be ready for connections. If you like, you can use the `wait.sh` script in the above mentioned `resources` directory to wait until keycloak is ready. A script from the resources folder initializing keycloak with a user "admin" with the password "admin" is run automatically.
Once keycloak is ready, navigate to `http://localhost:8080/admin` and login using the credentials `admin`/`admin`. Click on `Users` in the sidebar navigation, then click `Add user`. Enter the name of the new user (`admin`, for example), select email verified, and click `Save`. Then, click on the credentials tab and create your password. In the `Credentials` tab, add all available roles.
Then, run
```bash
docker-compose up -d server
```
The Sirix database is now ready for use.
Alternately, you can simply run
```bash
docker-compose up -d
```
to immediately create both the keycloak and sirix containers. Although the sirix container won't be able to immediately connect, it will continue retrying.
## Developing
### Code documentation
A lot of documentation is missing. However you can find general descriptions of the files in a directory in the `README.md` file in that directory. Currently, only some directories these READMEs, they are in the process of being added.
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](https://github.com/tauri-apps/tauri/wiki) 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-for-tauri`.
2. in another terminal, run `npm run dev:tauri`.
#### To build with Tauri
1. run `npm run export:tauri`.
2. run `npm run build:tauri`.