OzzyRMOzzyRMDocs
Installation

Verify install

Confirm imports and the docs UI load correctly.

Confirm the package resolves and the docs UI can load.

Import check

If the package installed correctly you should be able to import:

TypeScript
import { defineProject, prisma, drizzle, sql, loadCatalog } from "ozzyrm";
import { OzzyRMDocs } from "ozzyrm/react";
import { OzzyRMDocsFromConfig } from "ozzyrm/react/server";

If imports fail, clear your install and reinstall, then restart the dev server.

Runtime check

  1. Start your React app
  2. Open the route where you mounted OzzyRM
  3. Confirm the sidebar lists your schema sources and models

Optional watch mode

Schema file HMR needs the watcher. See Watch & HMR.

Next

On this page