Skip to content

Development Setup

Prerequisites

  • Rust 1.91.1+
  • Python 3.12+ (for Python bindings)
  • Node.js 20+ (for Node.js bindings)
  • Git

Clone Repository

git clone https://github.com/GrafeoDB/grafeo.git
cd grafeo

Build

# Build all crates
cargo build --workspace

# Build in release mode
cargo build --workspace --release

Run Tests

cargo test --workspace

Build Python Package

cd crates/bindings/python
uv add maturin
maturin develop

Build Node.js Package

cd crates/bindings/node
npm install
npm run build
npm test

IDE Setup

VS Code

Recommended extensions:

  • rust-analyzer
  • Python
  • TOML

IntelliJ/CLion

  • Install Rust plugin
  • Open as Cargo project