Getting Started with Rhythm Framework

Overview

Rhythm Framework helps teams ship documentation-driven products faster. This guide walks through the core concepts you need before going live.

Prerequisites

Make sure the following are available in your environment before you continue.

• Node.js 20 or later
• PostgreSQL 15+
• A configured API base URL

Verify your installation

Run the health check command to confirm services are reachable.

Next steps

After setup, continue with configuration and deployment guides in the sidebar.

Tip: keep product slugs stable once documentation links are shared externally.

Reference table

Setting	Description
API_URL	Backend base URL including /api/v1
DATABASE_URL	PostgreSQL connection string

npm install
npm run dev