Installation

Build AuraDeck from source and install it on your system.

AuraDeck does not ship pre-built binaries yet — you build it from source. The process takes a few minutes the first time and is fully scripted.

Prerequisites

Tool Version Why
Rust stable Compiles the Tauri backend.
Node.js 18 or later Runs the Tauri CLI build tooling.
Webview deps platform-specific See Tauri prerequisites for your OS.

On Linux you typically need webkit2gtk-4.1, libsoup-3.0, and a few build essentials. The Tauri docs page above lists the exact packages for each distribution.

Clone and build

git clone https://github.com/celray/auradeck.git
cd auradeck
npm install
npm run tauri build

The compiled binary ends up in src-tauri/target/release/auradeck. Tauri produces a single native executable with all web assets embedded — there is no dist/ directory to copy around.

For a faster development loop, use npm run tauri dev instead of build. This launches the app with hot-reload and source maps enabled.

Linux desktop integration

After building, run the install script to register AuraDeck with your desktop environment:

./linux/install-mime.sh           # install release binary
./linux/install-mime.sh --debug   # install debug binary

The script:

  • Copies the binary to ~/.local/bin/.
  • Installs an XDG .desktop entry so the app appears in your application menu.
  • Registers the application/x-auradeck-slides MIME type for .adsl files.
  • Installs an icon for the file type so .adsl archives show the AuraDeck logo in your file manager.

After running it, log out and back in (or run update-desktop-database ~/.local/share/applications and gtk-update-icon-cache ~/.local/share/icons) for everything to take effect.

macOS and Windows

The Tauri build pipeline produces native bundles for macOS (.dmg, .app) and Windows (.msi, .exe) automatically when you run npm run tauri build on those platforms. Ship-ready packaging instructions are coming soon — for now, the unpackaged binary in src-tauri/target/release/ works fine for personal use.

Webview engine

On macOS, AuraDeck uses the system WebKit. On Windows, it uses WebView2 (bundled with Windows 10 21H2+). On Linux, it uses WebKitGTK. Slide rendering is consistent across all three.

Try the quickstart →