Local Development

Use the public API docs to integrate Morface from your backend. Use this page when you also need the Morface application itself running locally.

Prerequisites

• Node.js >=20.6.0
• pnpm
• A configured .env.development
• Database access for app routes that depend on account, jobs, billing, or auth state

Install and start

git clone [email protected]:morfaceai/morface.git my-morface-project
cd my-morface-project
pnpm install
pnpm dev

The app starts with Next.js App Router and Turbopack.

Useful local routes

• /docs for the developer documentation site
• /account/api-keys to create and revoke API keys
• /pricing to inspect plan positioning and credits
• /showcase to review product-facing demos

Environment notes

• Keep .env.development aligned with the database and storage targets you want to test.
• Public API routes under /api/v1 require a valid API key created from the account area.
• If you change docs content or navigation metadata, regenerate Fumadocs artifacts so the page tree stays fresh.

Verification commands

pnpm exec tsc --noEmit
pnpm test

For targeted job stack checks, the repository also exposes verify commands such as:

• pnpm run verify:job-api-validation
• pnpm run verify:job-api-request-guard
• pnpm run verify:job-api-workflow
• pnpm run verify:job-api-route-post

Next step

If your goal is server integration rather than local app development, continue to API Quickstart.