Installation

Get Noderium running on your machine in under 10 minutes.

---

Prerequisites

Before you begin, make sure you have the following installed:

Requirement	Version	Notes
Rust	Stable	Install via rustup
Node.js	v20+ LTS	Download here
pnpm	Latest	Required for monorepo management
Build Dependencies	-	See Tauri prerequisites for your OS

Quick Check

# Verify installations
rustc --version
node --version
pnpm --version

---

Installation Steps

1. Clone the Repository

git clone https://github.com/leal32b/noderium.git
cd noderium

2. Install Dependencies

pnpm install

This will install all dependencies for the monorepo, including:

• Frontend dependencies (SolidJS, Tailwind CSS, DaisyUI, CodeMirror)
• Documentation site dependencies (Docusaurus)
• Shared package dependencies

3. Run the Application

pnpm app:dev

This starts both:

• Vite development server for the frontend
• Rust compiler in watch mode for the Tauri backend

The application will open automatically once compiled.

---

Monorepo Structure

noderium/
├── apps/
│   ├── app/           # Main application (Tauri + SolidJS)
│   │   ├── src/       # SolidJS Frontend (UI)
│   │   └── src-tauri/ # Rust Backend (Core Logic)
│   └── docs/          # Documentation (Docusaurus)
├── .changeset/        # Changesets configuration
├── pnpm-workspace.yaml
└── package.json

---

Platform-Specific Notes

macOS

Install Xcode Command Line Tools:

xcode-select --install

Linux (Debian/Ubuntu)

sudo apt update
sudo apt install libwebkit2gtk-4.1-dev \
  build-essential \
  curl \
  wget \
  file \
  libxdo-dev \
  libssl-dev \
  libayatana-appindicator3-dev \
  librsvg2-dev

Windows

1. Install Microsoft Visual Studio C++ Build Tools
2. Install WebView2

---

Troubleshooting

Rust compilation errors

Make sure you have the latest stable Rust:

rustup update stable

Node.js version mismatch

We recommend using a Node.js version manager like fnm or nvm:

# Using fnm
fnm use 20

# Using nvm
nvm use 20

pnpm not found

Install pnpm globally:

npm install -g pnpm

Or use corepack (recommended for Node.js 16.10+):

corepack enable
corepack prepare pnpm@latest --activate

---

Next Steps

Once installed, you're ready to:

1. Explore the editor: The Markdown editor supports syntax highlighting, keyboard shortcuts (Cmd/Ctrl+B for bold, Cmd/Ctrl+I for italic), and a distraction-free "hide markers" mode
2. Toggle themes: Use the theme toggle in the navbar to switch between light and dark modes
3. Read the architecture: Understand The Five Pillars that guide Noderium
4. Contribute: Check out our Contributing Guide

---

Development Commands

Command	Description
pnpm app:dev	Run the app in development mode
pnpm app:test	Run tests with coverage
pnpm app:test:watch	Run tests in watch mode
pnpm docs:dev	Run documentation site locally
pnpm build	Build all packages
pnpm app:lint	Run ESLint on app source and auto-fix