> ## 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.

# Start Here

> Use the Crave storefront toolkit to launch a custom ordering experience fast.

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 CLI** – `npx 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

| Tool               | Ideal for                     | Highlights                                                |
| ------------------ | ----------------------------- | --------------------------------------------------------- |
| **Crave CLI**      | Getting productive in minutes | Scaffolds templates, installs deps, optional auto-start   |
| **Storefront SDK** | React/TypeScript frontends    | Typed client, shared DTOs, pluggable auth token retrieval |
| **REST API**       | Any platform                  | Full 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](https://dashboard.craveup.com)
* At least one live location in your merchant account

## Where to go next

* [CLI Quickstart](./cli-quickstart) – scaffold and configure your storefront template
* [Storefront SDK](./storefront-sdk) – consume the API with TypeScript-first utilities
* [REST API Essentials](./rest-api) – interact with Crave from any language

Questions or feedback? Reach out at [hello@craveup.com](mailto:hello@craveup.com) or use the “Suggest edit” link in the sidebar.
