Rizm is a self-hosted workspace that brings boards, tables, a collaborative wiki, and AI-assisted operations into one place. This repository is the core repository for building, developing, and running Rizm from source. For the packaged public distribution and deployment-oriented setup, see rizm-workspace.
Rizm is designed to keep planning and execution in the same workspace. Its manifest-driven UI and AI assistance can work with the data already stored in the system, making it easier to adapt the workspace to each team's workflow. It also works well with external AI tools such as Cursor, making it useful for preserving and revisiting design decisions and requirements over time.
| Feature | Description |
|---|---|
| Project management | Boards and tables for structured work |
| Wiki | Real-time collaborative editing |
| MCP | Model Context Protocol server for integrating with tools such as Cursor and supporting long-term design and requirements reference |
| AI Assistant | Natural-language administration, user management, and data-aware actions |
| Requirement | Notes |
|---|---|
| Rust | Required for the backend. Install stable via rustup so cargo is available. |
| Node.js | 18 or newer (20.x LTS recommended). Used by the Vite-based frontend. |
| npm | For the repo root and script execution. |
-
Clone the repository.
git clone https://github.com/test-perspective/rizm-core.git cd rizm-core -
Create a local env file.
cp env.example .env
PowerShell example:
Copy-Item env.example .envSee the comments in
env.example. By default, the frontend uses the API athttp://localhost:48888, and the collaborative wiki uses the WebSocket endpoint atws://localhost:48889/api/wiki/collab/ws. -
Install dependencies at the repo root (
npm ciis recommended whenpackage-lock.jsonis present).npm ci
-
In Terminal 1, start the API and, if needed, the collaboration server.
bash scripts/dev-backend.sh
Windows:
powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\dev-backend.ps1
The backend listens on
127.0.0.1:48888, anddev-collab.mjsis started as a child process on port48889. If you do not need collaborative editing locally, usebash scripts/dev-backend.sh --no-collab. Run--helpto see other options. -
Terminal 2 — Start the Vite dev server.
bash scripts/dev-frontend.sh
Windows:
powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\dev-frontend.ps1
-
Open
http://localhost:5173. Default bootstrap credentials match the dev scripts:admin@example.local/change-this-password.
In this public tree, VITE_MUI_X_LICENSE_KEY is not set by default. As a result, the current setup shows license notices or watermarks for MUI X Premium components such as Data Grid Premium. If you obtain and set a valid license key, those notices can be suppressed. For the public version, we recommend either purchasing an MUI X license or migrating to MUI X Community where feasible. See env.example for configuration details.
| Category | Main technologies |
|---|---|
| Frontend | React, TypeScript, Tailwind CSS, Vite, MUI Material, BlockNote, Monaco Editor |
| Backend | Rust (Axum, Tokio) |
| Data | SQLite |
Licensed under the Apache License, Version 2.0. See LICENSE.
Rizm is still evolving, so behavior and APIs may change over time. If you plan to use it for important workloads, validate it thoroughly first.