> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Build with Crave

> Start with your coding agent, then explore Crave storefronts, APIs, and supported integrations.

Crave gives food and beverage developers the ordering layer they usually have to stitch together themselves: menu data, modifiers, cart state, checkout, fulfillment, payments, analytics, reusable UI components, and APIs that work across web and mobile apps.

Crave.js is the storefront developer surface inside **Crave Cloud**, a managed platform for franchise ordering, identity boundaries, loyalty integrations, payment routing, and multi-location operations.

## Start with your coding agent

Give your agent the setup guide and let it inspect your app, connect current
Crave documentation, and verify the integration in Sandbox.

```text wrap theme={null}
Set up Crave using this guide:
https://developer.craveup.com/agents.md
Start in sandbox. Verify locally.
```

> [card] [Set up Crave with an agent](/docs/ai-onboarding.md)
>
> One prompt, current documentation, and a clear setup checklist for Claude
> Code, Cursor, Codex, and other coding agents.

Already have a supported API and SDK pair and prefer to work manually? Use the
[CLI quickstart](/docs/getting-started/cli-quickstart.md) or your framework's guide below.
For a new managed workspace, check [Cloud availability](/docs/guides/crave-cloud-overview.md)
first; provisioning is currently assisted.

## Explore the platform

> [card] [Crave Cloud Overview](/docs/guides/crave-cloud-overview.md)
>
> Understand how Crave.js fits into the broader franchise platform.

> [card] [Deploy Safely](/docs/guides/deployment.md)
>
> Register exact browser origins and keep private credentials out of
> storefront bundles.

> [card] [Set up with an agent](/docs/ai-onboarding.md)
>
> Give your coding agent the current setup instructions and docs connection.

> [card] [CLI Quickstart](/docs/getting-started/cli-quickstart.md)
>
> Learn the CLI flags, templates, and generated project structure.

> [card] [Storefront SDK](/docs/getting-started/storefront-sdk.md)
>
> Connect your UI to menus, carts, checkout, and analytics with typed helpers.

> [card] [REST API Essentials](/docs/getting-started/rest-api.md)
>
> Call Crave endpoints from any platform using standard HTTP requests.

## Where this fits

> [card] [Developer Package and Crave Cloud](/docs/guides/open-source-and-cloud.md)
>
> Learn what is available to developers and what stays managed by Crave Cloud.

> [card] [Build a Custom Storefront](/docs/guides/build-custom-storefront.md)
>
> Combine the CLI, Storefront SDK, REST APIs, and UI components for a branded
> ordering experience.

> [card] [Prebuilt Storefront Prompt](/docs/guides/ai/build-storefront-prompt.md)
>
> Give Cursor, Claude, ChatGPT, Codex, or another agent the right Crave
> context before it edits your app.

## Quickstarts & Tutorials

Explore our end-to-end tutorials and getting started guides for different application stacks.

> [card] [Next.js](/docs/quickstarts/nextjs.md)
>
> Build a storefront with Next.js 16.3 App Router and the Crave SDK.

> [card] [React](/docs/quickstarts/react.md)
>
> Get started with React + Vite and the Crave SDK.

> [card] [Vanilla JavaScript](/docs/quickstarts/vanilla-js.md)
>
> Build a storefront with plain JavaScript and the REST API.

> [card] [React Native](/docs/quickstarts/mobile.md)
>
> Create a mobile ordering app with Expo and the Crave SDK.

## UI Components

Crave's prebuilt UI components give you a fully-functional ordering experience in minutes — menus, carts, checkout, and fulfillment out of the box.

> [card] [Component Overview](/docs/components/overview.md)
>
> Browse all available components and learn how they work together.

> [card] [Storefront SDK](/docs/getting-started/storefront-sdk.md)
>
> The TypeScript SDK that powers the components and data fetching.

## SDK & API Reference

Dig into our SDK reference documentation and REST API endpoints. Everything you need to integrate Crave into any application.

> [card] [SDK Reference](/docs/api-reference/overview/api-overview.md)
>
> API overview, authentication, endpoints, and response formats.

> [card] [Core Concepts](/docs/api-reference/overview/core-concepts.md)
>
> Merchants, locations, menus, carts, and the ordering lifecycle.

## Explore by feature

Crave supports the full ordering lifecycle. Pick a feature to dive deep.

> [card] [Menu & Products](/docs/guides/display-menu.md)
>
> Display categories, products, and modifiers. Support multiple menus with
> scheduled availability.

> [card] [Cart & Ordering](/docs/guides/manage-cart.md)
>
> Manage the cart lifecycle — add items, apply modifiers, handle discounts,
> and submit orders.

> [card] [Payments](/docs/guides/accept-payments.md)
>
> Submit the order first, render Stripe-only online payment UI, and recover
> the exact attempt.

> [card] [Fulfillment](/docs/guides/fulfillment-methods.md)
>
> Configure takeout, delivery, table-side ordering, and room service for your
> locations.

> [card] [Analytics](/docs/guides/analytics.md)
>
> Track funnel events across the ordering flow and measure conversion rates.

> [card] [Outbound Webhooks (Planned)](/docs/guides/webhooks.md)
>
> Review the current availability boundary before designing an event-driven
> integration.

## Explore by framework

> [card] [Next.js](/docs/quickstarts/nextjs.md)
>
> Server-side rendering with the App Router. Fetch menus on the server, manage
> carts on the client.

> [card] [React](/docs/quickstarts/react.md)
>
> Client-side React with Vite. Build a custom SPA storefront with the SDK.

> [card] [Vanilla JavaScript](/docs/quickstarts/vanilla-js.md)
>
> No framework required. Call the REST API directly from plain JavaScript.

> [card] [React Native / Expo](/docs/quickstarts/mobile.md)
>
> Build native mobile ordering apps with Expo and the Crave SDK.

## Beyond the basics

> [card] [Theming](/docs/guides/theming.md)
>
> Customize colors, fonts, and component styles to match your restaurant's
> brand.

> [card] [Testing](/docs/guides/testing.md)
>
> Use test mode, mock data, and example test suites to validate your
> integration.

> [card] [Deployment](/docs/guides/deployment.md)
>
> Deploy to Vercel, Netlify, Docker, or custom hosting with production best
> practices.

> [card] [Error Handling](/docs/guides/error-codes.md)
>
> Handle every error the API can return with status codes, retry strategies,
> and user messages.

## Community

> [card] [Slack](https://join.slack.com/t/cravejscommunity/shared_invite/zt-3hfr081io-aYuLC3n6gBFKQuho0HrTng)
>
> Connect with the Crave community on Slack.

> [card] [Support](mailto:hello@craveup.com)
>
> Reach out to our team directly for help with your integration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.