Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 3.29 KB

File metadata and controls

70 lines (47 loc) · 3.29 KB

Installation

Sift targets Windows for production bundles; developers may also build on macOS or Linux for the same codebase.

Prerequisites

Required for development

Tool Version Notes
Node.js 18+ (LTS recommended) npm comes with Node
Rust Latest stable rust-toolchain.toml in the repo pins stable
WebView2 Runtime Windows: usually preinstalled on Windows 10/11. Tauri uses the Evergreen runtime.

Optional

Tool Purpose
Git Clone and version control
Local LLM server OpenAI-compatible HTTP API (for example llama.cpp llama-server, LM Studio, Ollama)

Clone the repository

git clone https://github.com/fleXRPL/sift.git
cd sift

Install JavaScript dependencies

Install at the repository root, frontend, and backend:

npm install
npm install --prefix frontend
npm install --prefix backend

The root package.json provides orchestration scripts (npm run dev, npm run build) and the Tauri CLI.

Rust / Cargo

On first npm run dev or cargo build inside src-tauri/, Cargo downloads crates. Ensure you have network access for crates.io.

If your system Rust is very old, update it:

rustup update stable

Windows-specific notes

  • WebView2: If the app window fails to render, install the WebView2 Evergreen Runtime.
  • Long paths: If builds fail with path length errors, enable long paths or clone into a shorter path (for example C:\dev\sift).
  • Antivirus: Corporate AV may slow first runs of node.exe or the built .exe; allowlisting the dev folder helps.

macOS / Linux (development only)

  • Tauri builds use the platform WebView (Wry). Install Xcode Command Line Tools on macOS if prompted.
  • Linux may need additional WebKit/GTK packages per Tauri prerequisites.

Verify installation

node --version
rustc --version
npm run dev

If the Sift window opens and the dashboard shows the orchestrator online, installation is complete. See Quick start for the shortest happy path.