Skip to main content
Crave gives you three building blocks for your storefront: a CLI to bootstrap projects, a Storefront SDK for JavaScript apps, and a REST API for everything else. This overview explains how the pieces fit together so you can ship confidently.

Build workflow

  1. Scaffold with the CLInpx craveup init clones an opinionated Next.js storefront, installs dependencies, and prompts for your Crave credentials.
  2. Configure environment variables – Add your API key and default location IDs to the generated .env.local.
  3. Extend with the Storefront SDK – Import @craveup/storefront-sdk to fetch menus, manage carts, and submit analytics from your UI.
  4. Call the REST API when needed – Non-JavaScript clients (native apps, server automations) can hit the same endpoints directly over HTTPS.

Choose the right tool

ToolIdeal forHighlights
Crave CLIGetting productive in minutesScaffolds templates, installs deps, optional auto-start
Storefront SDKReact/TypeScript frontendsTyped client, shared DTOs, pluggable auth token retrieval
REST APIAny platformFull coverage of storefront operations via standard HTTP

Prerequisites

  • Node.js 18+ and a package manager (pnpm, npm, or yarn)
  • A Crave API key from the Crave Dashboard
  • At least one live location in your merchant account

Where to go next

Questions or feedback? Reach out at hello@craveup.com or use the “Suggest edit” link in the sidebar.