Hellebore

Hellebore is a self-hosted desktop app that helps creatives track their fictional settings. Great for DMs and writers.

Local Development

Dependencies

• rust: https://www.rust-lang.org/tools/install
• node.js >=22: https://nodejs.org/en/download
• pnpm: https://pnpm.io/installation
• sqlite 3: https://www.sqlite.org/download.html

Setup

1. Install the front-end.

pnpm install

2. Install the back-end.

cargo install --path src-tauri

3. Install the sea-orm cli

cargo install [email protected]

4. Configure the development environment via a .env file in the project root.

HELLEBORE_DATA_DIR="data"
HELLEBORE_DEFAULT_DB_FILE="db.sqlite"

# required for sea-orm-cli entity generation
DATABASE_URL="sqlite://src-tauri/data/db.sqlite?mode=rwc"

5. Serve the app.

pnpm run dev

DB Entity Generation

To regenerate the DB entity models, run the following:

pnpm run build:entities