Development Setup

Development Setup

RootSpace is a monorepo consisting of a Rust engine and a Node.js dashboard. Follow these steps to set up your local development environment.

---

🔧 Prerequisites

• Rust toolchain (>= 1.85.0)
• Node.js (>= 20.x)
• npm (>= 10.x)
• CMake and a C compiler (for rusqlite / wasmtime dependencies)

---

🚀 Building from Source

1. Clone the Repository

git clone https://github.com/johnvteixido/RootSpace.git
cd RootSpace

2. Build the Rust Core

The Rust backend is located in the rust-v2 directory.

cd rust-v2
cargo build --release

Note: We recommend building in --release mode for testing, as wasmtime execution can be noticeably slower in debug builds.

3. Install Node.js Dependencies

The dashboard and companion APIs are located in the root and dashboard/ directory.

# From the repository root
npm install
cd dashboard
npm install

4. Run the Development Servers

It's easiest to run the Node server and the Rust engine in separate terminal windows.

Terminal 1 (Rust):

cd rust-v2
cargo run -- run

Terminal 2 (Node):

npm run dev

---

🧪 Running Tests

RootSpace utilizes automated CI, so ensure all local tests pass before opening a Pull Request.

Rust Tests:

cd rust-v2
cargo test
cargo clippy -- -D warnings

Node Tests:

npm test