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

# Welcome to Salesive

> Build, launch, and scale commerce experiences with the Salesive platform

<Hero title="Ship faster with Salesive" description="Salesive gives founders and operators everything needed to sell online—powerful storefront tooling, automation-first operations, and an extensible developer stack." icon="store" ctaText="Join the waitlist" ctaLink="https://salesive.com" secondaryCtaText="Explore the docs" secondaryCtaLink="/quickstart" align="center" />

## Quick access

<CardGroup cols={2}>
  <Card title="Salesive Store API" icon="code" href="/api-reference/introduction">
    Complete REST API for products, carts, orders, shipping, and customer
    authentication. Build custom storefronts or integrate with existing
    systems.
  </Card>

  <Card title="Salesive API Axios Client" icon="plug" href="https://www.npmjs.com/package/salesive-api-axios">
    Typed Axios wrappers for the Store API. Smart environment detection,
    automatic token management, and full TypeScript support.
  </Card>

  <Card title="Salesive Dev Tools" icon="wrench" href="https://www.npmjs.com/package/salesive-dev-tools">
    CLI and Vite plugin for building Salesive templates. Features template
    scaffolding, configuration management, React hooks, and one-command
    deployment.
  </Card>

  <Card title="Salesive Widget" icon="window-maximize" href="/widget">
    Widget system with Live Support Chat, automatically included in all
    storefronts. Full programmatic control via global API.
  </Card>
</CardGroup>

## Getting started

Salesive equips product teams with an integrated toolkit for launching modern commerce experiences. Begin with a high-level understanding of the platform, then navigate directly to the implementation path that fits your build strategy:

* **Salesive Store API** delivers secure, RESTful access to catalog, inventory, orders, shipping, wishlists, and customer authentication.
* **Salesive API Axios Client** (`salesive-api-axios`) provides typed Axios wrappers with smart environment detection, automatic token management, and full TypeScript support for seamless API integration.
* **Salesive Dev Tools** (`salesive-dev-tools`) is a powerful CLI and Vite plugin for creating, managing, and deploying Salesive templates with dynamic configuration, React hooks, and one-command deployment.
* **Salesive React Component Library** (`salesive-components`) accelerates UI delivery with production-ready carts, auth flows, analytics widgets, and PWA helpers.
* **Salesive Widget** is a widget system automatically included in all storefronts, featuring Live Support Chat with route filtering, dark mode, and a global JavaScript API.

<Columns cols={2}>
  <Card title="Project quickstart" icon="rocket" href="/quickstart">
    Initialize your workspace, configure environments, and run the docs
    locally.
  </Card>

  <Card title="Platform tooling" icon="toolbox" href="https://www.npmjs.com/package/salesive-dev-tools">
    Install the Salesive CLI (`salesive-dev-tools`) to scaffold templates,
    manage configurations, and deploy with `salesive cook`.
  </Card>
</Columns>

## Store types

Every Salesive store has a **type** that determines the catalog it sells and how
checkout behaves. The store type drives the `catalogType` and per-item `itemType`
returned by the Store API, and a theme declares the types it supports via
[`shopTypes`](/development#define-your-salesive-config) in `salesive.config.json`.

| Store type   | Sells        | Catalog item | `catalogType` | Notable traits                                                                                    |
| ------------ | ------------ | ------------ | ------------- | ------------------------------------------------------------------------------------------------- |
| `ecommerce`  | Products     | Product      | `product`     | Variants, inventory, and shipping.                                                                |
| `restaurant` | Foods (menu) | Food         | `food`        | Add-ons; no variants.                                                                             |
| `business`   | Services     | Service      | `service`     | Add-ons; **no shipping** (online payment, manual fulfilment). Uses `*.salesive.click` subdomains. |

When you build a storefront, branch on the catalog type rather than hard-coding a
single shape. The same cart, wishlist, and order endpoints serve all three types —
you simply send the matching identifier (`productId`, `foodId`, or `serviceId`) and
read the `itemType` on each returned line item.

<Note>
  Foods and services share the same add-on model and have no variants, so a theme
  that already renders restaurant menus needs only minor changes to support business
  (service) stores. Service orders are non-shippable: `shippingCost` is `0` and no
  shipment is created.
</Note>

## Salesive Store API

Use the API to orchestrate backend workflows or power custom storefronts. Key capabilities include product management, shopping carts, order processing, shipping coordination, customer authentication, and address intelligence with geocoding.

<CardGroup cols={2}>
  <Card title="API Overview" icon="diagram-project" href="/api-reference/introduction">
    Review authentication flows, JWT tokens, guest sessions, headers, and
    API conventions.
  </Card>

  <Card title="Endpoint Reference" icon="list-check" href="/api-reference/endpoint/auth/create-ghost">
    Explore all endpoints: authentication, products, cart, orders, shipping,
    wishlist, and address autocomplete.
  </Card>
</CardGroup>

## Salesive API Axios Client

Integrate the Store API with minimal boilerplate using `salesive-api-axios`. This lightweight SDK provides typed Axios wrappers for authentication, cart, orders, products, shipping, and more—with automatic environment detection and token management for Vite projects.

<CardGroup cols={2}>
  <Card title="Install the package" icon="download" href="https://www.npmjs.com/package/salesive-api-axios">
    Add `salesive-api-axios` to your project and start making API calls with
    TypeScript support and smart token management.
  </Card>

  <Card title="API modules" icon="puzzle-piece" href="/api-reference/introduction">
    Explore organized modules for auth, cart, orders, products, shipping,
    banners, blogs, and shipping addresses.
  </Card>
</CardGroup>

## Salesive Dev Tools

Build and manage Salesive templates with the `salesive-dev-tools` CLI and Vite plugin. Features include template scaffolding, dynamic configuration with React hooks, CSS variable injection, and one-command deployment to the Salesive Themes API.

<CardGroup cols={3}>
  <Card title="CLI Commands" icon="terminal" href="https://www.npmjs.com/package/salesive-dev-tools">
    Initialize projects, authenticate with the API, validate configurations,
    and deploy templates with `salesive cook`.
  </Card>

  <Card title="Vite Plugin" icon="plug-circle-bolt" href="https://www.npmjs.com/package/salesive-dev-tools">
    Inject configuration into your React app and access it via the
    `useSalesiveConfig` hook and global config object.
  </Card>

  <Card title="Configuration Management" icon="sliders" href="https://www.npmjs.com/package/salesive-dev-tools">
    Define variables in `salesive.config.json` and access them dynamically
    throughout your app with runtime updates.
  </Card>
</CardGroup>

## Salesive React Component Library

Embed polished storefront UX with the `salesive-components` package. Each component is API-aware, accessible, and themeable, enabling rapid experimentation without sacrificing quality.

<Columns cols={2}>
  <Card title="Install the library" icon="cube" href="https://www.npmjs.com/package/salesive-components">
    Add the component library, configure providers, and sync styling tokens.
  </Card>

  <Card title="Component reference" icon="layer-group" href="/essentials/code">
    Explore usage examples for carts, waitlist modals, analytics surfaces,
    and more.
  </Card>
</Columns>

## Salesive Widget

The Salesive Widget system is automatically included and initialized in all Salesive storefronts. It provides embeddable UI components with Shadow DOM isolation, route-based visibility, dark mode, and a complete JavaScript API for programmatic control.

<CardGroup cols={2}>
  <Card title="Live Support Chat" icon="comment" href="/widget#live-support-chat">
    Real-time chat connecting customers with your sales and support team.
  </Card>

  <Card title="Widget API" icon="code" href="/widget#api-methods">
    Control visibility, route filtering, dark mode, and more via the global
    API.
  </Card>
</CardGroup>

## Next steps

<Steps>
  <Step title="Integrate across the stack">
    Combine the API, starter, and component library to deliver cohesive
    customer journeys.
  </Step>

  <Step title="Automate operations">
    Leverage webhooks, analytics, and deployment tooling to streamline
    fulfillment and retention.
  </Step>

  <Step title="Collaborate with Salesive">
    Engage the Salesive team for roadmap updates, beta features, and launch
    support at{" "}
    <a href="mailto:support@salesive.com">[support@salesive.com](mailto:support@salesive.com)</a>.
  </Step>
</Steps>