Skip to content

Self-Hosting ​

RichView is open source (AGPL-3.0) and designed to be self-hosted. The platform consists of a Node.js backend API and a React web frontend.

Architecture ​

ComponentTechnologyPurpose
API serverNode.js (Fastify) on Fly.ioStorage, auth, analytics, WebSocket
Web frontendReact SPA on Cloudflare PagesEditor, report viewer
Published reportsStatic HTML on Cloudflare PagesSelf-contained HTML files
DocsVitePress on Cloudflare PagesThis documentation site

Prerequisites ​

  • Node.js 20+
  • pnpm 9+

Running locally ​

Clone the repository and install dependencies:

bash
git clone https://github.com/richview-universe/richview-v2.git
cd richview-v2
pnpm install
pnpm build

Start the API server:

bash
pnpm --filter @richview/server dev

Start the web frontend:

bash
pnpm --filter @richview/web dev

CLI-only usage ​

If you only need report generation (no web editor), install the CLI globally:

bash
npm install -g @richview/cli
richview generate report.yaml

Infrastructure (production) ​

For production deployment, RichView uses:

Cloudflare ​

  • DNS: Domain registered and managed via Cloudflare
  • Pages: Hosts the web frontend and published reports
  • API token permissions: Zone DNS (Edit), Page Rules (Edit), Cloudflare Pages (Edit)

Fly.io ​

  • API server: Runs on Fly.io free tier (3 shared VMs, 3 GB volume, 160 GB transfer/month)
  • Deploy token: Created via fly tokens create deploy

Environment variables ​

VariablePurpose
CLOUDFLARE_API_TOKENCloudflare API access
CLOUDFLARE_ACCOUNT_IDCloudflare account identifier
FLY_API_TOKENFly.io deployment

MCP server ​

Run the MCP server for AI agent integration:

bash
# stdio (for Claude Desktop)
npx @richview/mcp-server

# HTTP (for remote clients)
npx @richview/mcp-server --http --port 3001

See the MCP Server Guide for configuration details.

Released under the Elastic License 2.0 (ELv2).