Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cravejs.com/llms.txt

Use this file to discover all available pages before exploring further.

Crave provides a complete toolkit for building food ordering storefronts — a CLI to scaffold projects, a TypeScript SDK for frontend apps, prebuilt UI components, and a REST API for any platform. These docs cover everything from your first quickstart to production deployment. Find the right guide for your needs, whether you’re just getting started or looking to implement advanced ordering flows.

Quickstarts & Tutorials

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

Next.js

Build a storefront with Next.js 15 App Router and the Crave SDK.

React

Get started with React + Vite and the Crave SDK.

Vanilla JavaScript

Build a storefront with plain JavaScript and the REST API.

React Native

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.

Component Overview

Browse all available components and learn how they work together.

Storefront SDK

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.

SDK Reference

API overview, authentication, endpoints, and response formats.

Core Concepts

Merchants, locations, menus, carts, and the ordering lifecycle.

Explore by feature

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

Menu & Products

Display categories, products, and modifiers. Support multiple menus with scheduled availability.

Cart & Ordering

Manage the cart lifecycle — add items, apply modifiers, handle discounts, and submit orders.

Payments

Accept payments with Stripe Connect. Handle payment intents, test cards, and error recovery.

Fulfillment

Configure takeout, delivery, table-side ordering, and room service for your locations.

Analytics

Track funnel events across the ordering flow and measure conversion rates.

Webhooks

Receive real-time notifications for order lifecycle events like creation, confirmation, and completion.

Explore by framework

Next.js

Server-side rendering with the App Router. Fetch menus on the server, manage carts on the client.

React

Client-side React with Vite. Build a custom SPA storefront with the SDK.

Vanilla JavaScript

No framework required. Call the REST API directly from plain JavaScript.

React Native / Expo

Build native mobile ordering apps with Expo and the Crave SDK.

Beyond the basics

Theming

Customize colors, fonts, and component styles to match your restaurant’s brand.

Testing

Use test mode, mock data, and example test suites to validate your integration.

Deployment

Deploy to Vercel, Netlify, Docker, or custom hosting with production best practices.

Error Handling

Handle every error the API can return with status codes, retry strategies, and user messages.

Community

Discord

Join our Discord server to chat with the team and other developers.

Slack

Connect with the Crave community on Slack.

Support

Reach out to our team directly for help with your integration.