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

# Installing Spree

> Install Spree Commerce locally, run your first store, and deploy it to production with the official starter template.

## Using `create-spree-app`

The quickest way to get started. Scaffolds a full Spree project with React admin dashboard and Next.js Storefront (optional).

**Requirements:** [Node.js](https://nodejs.org/) 24+ and [Docker](https://docs.docker.com/get-docker/) running.

```bash theme={"theme":"night-owl"}
npx create-spree-app@latest my-store
```

The CLI walks you through an interactive setup where you choose the project name and whether to include the Next.js Storefront. It then builds a Docker stack with Postgres, and Spree API.

Once complete it will open a browser window so you can finalize the store setup (pick name, currency, your email/password).

<Frame caption="Setting up your first store">
  <video autoPlay muted loop playsInline controls className="block w-auto max-w-full h-auto rounded-xl" src="https://mintcdn.com/spreecommerce/-F-mvTzFFZM31HGv/videos/store-setup.mp4?fit=max&auto=format&n=-F-mvTzFFZM31HGv&q=85&s=4d678957fb3cd296485050e554aaec93" data-path="videos/store-setup.mp4" />
</Frame>

## Project structure and overview

`create-spree-app` creates a project folder like this:

```
my-store/
├── server/                 # The Spree API
├── apps/
│   ├── dashboard/          # Admin dashboard (Vite/React)
│   ├── seller-dashboard/   # Seller panel, for marketplaces (Vite/React)
│   └── storefront/         # Next.js storefront (if selected)
├── .env                    # Ports, secrets and service URLs
├── .spree/                 # CLI credentials — gitignored, created on first run
├── docker-compose.yml      # The local stack
├── package.json            # Scripts and the pinned @spree/cli
├── AGENTS.md               # Instructions for coding agents
├── CLAUDE.md               # Project layout and conventions
└── README.md               # How to run everything
```

## Using the Spree CLI

Projects scaffolded with `create-spree-app` include [`@spree/cli`](/docs/developer/cli/quickstart) for managing the backend and calling the Admin API. Because it's a project dependency, run it with `npx` (or any package-manager script):

```bash theme={"theme":"night-owl"}
npx spree dev               # boot the Docker stack
npx spree api get products  # query the Admin API (read-only key preconfigured)
```

Project setup mints a read-only Admin API key into `.spree/credentials.json` (and `spree api` mints it on first use if you skipped setup), so `spree api` works without any extra configuration.

To call `spree` directly without the `npx` prefix, install the CLI globally:

```bash theme={"theme":"night-owl"}
npm install -g @spree/cli
spree api get products
```

See the [Spree CLI guide](/docs/developer/cli/quickstart) for all commands and the [Admin API from the CLI](/docs/developer/cli/admin-api) for querying your store's data.

## Next Steps

<Card title="How Spree fits together" icon="brain" href="/docs/developer/core-concepts/architecture" horizontal>
  The catalog, the cart, the order and fulfillment — what each one is for, and the two APIs you build against. Twenty minutes here saves a lot of guessing later, and it ends by pointing you at whichever path suits you.
</Card>

In a hurry? Jump straight to the [tutorial](/docs/developer/tutorial/introduction) to build a feature end to end, the [Next.js Storefront](/docs/developer/storefront/nextjs/quickstart) to put a storefront in front of it, or the [API reference](/docs/api-reference/admin-api/introduction) to see what you can do with the Admin API.

<Tip>
  Using an AI coding agent? Run `npx skills add spree/agent-skills` in your new project — it teaches your agent the customization patterns before you write a line of code. See [Agentic Development](/docs/developer/agentic/overview).
</Tip>

***

Congrats! You've set up your Spree application and it's looking amazing!

Give Spree a [GitHub Star](https://github.com/spree/spree)<Icon icon="star" iconType="solid" color="#FFD43B" />, why don't ya? Thank you for supporting Spree open-source! <Icon icon="heart" iconType="solid" color="#FF0000" />

Need support or want to give some feedback? Join our [Discord](https://discord.spreecommerce.org/)


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