The backend is implemented using SurrealDB and its embedded or native Rest capabilities. This allows us to directly access the DB with authentication and saves us from having to write a custom backend.
If the DB is intended to be used for centralized data storage - thus requiring it to be installed on a remote server - the following chapters help to set up the system on the server.
The DB can be installed locally using the provided scripts.
- Change working directory to where this README resides
- Execute
./scripts/install.shto run the install script.
The script installs the DB from the official online sources, starts it in a screen session and imports the provided setup.surql file.
- Linux OS
bashinstalledscreeninstalled
Alternatively the DB can be installed as described here. It can then manually be run in the background (like this) and the setup can be loaded using this command.
When the whole software runs locally as desktop application, SurrealDB is provided
as embedded library in the Tauri backend code. It also uses the setup.surql
script to initialize the DB upon first use.
The setup.surql SurrealQL script, which configures and prepares the DB to be used with this project,
can be used in any way (f.e. to setup dev environments). It represents the Data Model
in a way understandable for SurrealDB.