RidgeCRM Developer Docs

Start Here

Local development

Run RidgeCRM locally and verify the platform APIs before building integrations.

Install and run

Use the project scripts as the source of truth. Prisma generation runs after install, and the SvelteKit dev server hosts the site and API routes.

bash

Local app startup

pnpm install
pnpm run db:push
pnpm run dev

Health check

The simplest programmatic check is the v1 health endpoint on the same host as the app.

bash

Check API health

curl http://localhost:5173/api/v1/health

Configuration to know

  • Database and Prisma settings control all standard and metadata-backed CRM records.
  • JWT settings affect `/api/v1` integrations.
  • SMTP2GO-style settings support email setup, templates, webhooks, and tracking.
  • Twilio settings power telephony setup, incoming/status callbacks, and browser calling tokens once the SDK is implemented.