Skip to content

Commit 2290f63

Browse files
alexphelpsalexphelps
committed
improve getting started and switch to Lucide Icons
1 parent 15dbfba commit 2290f63

9 files changed

Lines changed: 373 additions & 88 deletions

File tree

‎docs/index.md‎

Lines changed: 98 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,113 @@ title: Getting Started
33
sidebar_position: 0
44
---
55

6-
⚡️ Developers have full access to a suite of APIs, Webhooks, and Themes to solve complex commerce problems for merchants and brands.
6+
Next Commerce is an ecommerce platform for DTC merchants. It includes a full storefront, checkout, payments, and order management — plus a headless campaigns layer for building custom checkout funnels. Use this guide to find the right starting point for what you're building.
77

8-
### Solve Complex Problems with Apps
8+
## Platform Overview
99

10-
🚀 Apps combine the power of our [Admin APIs](/docs/admin-api/index.md), [Webhooks](/webhooks.md), and theme [App Hooks](/) giving developers the tools they need to add new integrations and solve complex problems with an installable app flow.
10+
Campaigns and storefronts are the customer-facing layer — both produce orders in your Next Commerce store. The Admin API gives you programmatic access to all store data. Apps are how you package and distribute integrations across multiple stores.
1111

12-
### Create Unique Brand Experiences with Themes
12+
```mdx-code-block
13+
import IntroCards from '@site/src/components/IntroCards';
1314
14-
🎯 Use [Theme Kit](/docs/storefront/themes/theme-kit.md) to build custom themes that offer amazing brand experiences for customers. Get started with our [Intro](https://github.com/29next/intro) or [Intro Bootstrap](https://github.com/29next/intro-bootstrap) themes to get up and running quickly.
15+
<IntroCards />
16+
```
1517

18+
## What Are You Building?
1619

17-
### Getting Started
20+
---
1821

22+
### Build a Campaign Funnel
1923

20-
```mdx-code-block
24+
Use campaigns to build external checkout experiences that run outside the storefront — landing pages, checkout, upsell flows, and receipt pages.
2125

22-
import IntroCards from '@site/src/components/IntroCards';
26+
**Choose your approach**
2327

24-
<IntroCards />
28+
| Approach | Best for | Description |
29+
| --- | --- | --- |
30+
| [Campaign Cart SDK](/docs/campaigns/campaign-cart/) | Fastest path | HTML/JS SDK using `data-next-*` attributes — no custom JavaScript required |
31+
| [Campaigns API](/docs/campaigns/api/) | Full control | Headless JS API for custom checkout implementations |
2532

26-
```
33+
**Get started**
34+
35+
1. In your dashboard, install the **Campaigns App** and create a campaign
36+
2. Add packages linked to product variants in your catalog
37+
3. Get your **API Key** from the campaign's **Integration** tab
38+
4. Clone the [Campaign Cart Starter Template](https://github.com/29next/campaign-cart-example) — a pre-built landing page, checkout, upsell, and receipt flow ready to customize
39+
40+
**Resources**
41+
- [Campaigns overview](/docs/campaigns/) — campaign structure and funnel flow
42+
- [Campaign Cart SDK](/docs/campaigns/campaign-cart/) — data attributes, JS API, and utilities
43+
- [Campaigns API](/docs/campaigns/api/) — REST API reference
44+
- [Analytics](/docs/campaigns/campaign-cart/analytics/) — session tracking, custom events, and third-party integrations
45+
46+
---
47+
48+
### Customize a Storefront Theme
49+
50+
Use themes to control the appearance and behavior of your storefront — product pages, catalog, cart, and storefront checkout flow. Themes use HTML, CSS, JavaScript, and a liquid-like template language with access to storefront objects and a GraphQL API.
51+
52+
**Get started**
53+
54+
1. Install [Theme Kit](/docs/storefront/themes/theme-kit.md), the CLI for local theme development
55+
2. Start from the [Intro](https://github.com/29next/intro) or [Intro Bootstrap](https://github.com/29next/intro-bootstrap) starter theme
56+
3. Run `theme pull` to sync files locally, make changes, then `theme push` to deploy
57+
58+
**Resources**
59+
- [Themes overview](/docs/storefront/themes/) — theme structure and Theme Kit
60+
- [Template reference](/docs/storefront/themes/templates/) — tags, objects, filters, and URL routing
61+
- [Theme guides](/docs/storefront/themes/guides/) — custom page templates, product templates, and variants
62+
- [Storefront GraphQL API](/docs/storefront/api.md) — fetch products, cart data, and more
63+
- [Event tracking](/docs/storefront/event-tracking.md) — track storefront events and conversions
64+
65+
---
66+
67+
### Integrate with the Admin API
68+
69+
Use the Admin API to manage store data and build backend integrations — orders, subscriptions, products, customers, and fulfillment. All requests authenticate with OAuth 2.
70+
71+
**Get started**
72+
73+
1. In your dashboard, go to **Settings > API Access** and create an OAuth App
74+
2. Select the [permissions](/docs/admin-api/permissions.md) your integration needs to get an Access Token
75+
76+
**Resources**
77+
- [Admin API overview](/docs/admin-api/) — authentication, versioning, and rate limits
78+
- [API reference](/docs/admin-api/reference/) — full endpoint reference
79+
- [Order management](/docs/admin-api/guides/order-management.md) — create and manage orders
80+
- [Subscription management](/docs/admin-api/guides/subscription-management.md) — recurring billing
81+
- [Payment integrations](/docs/admin-api/guides/) — Apple Pay, Google Pay, PayPal, Klarna, and more
82+
83+
---
84+
85+
### Build an App
86+
87+
Use apps to package an integration as an installable unit that works across multiple stores. An app can combine the Admin API, Webhooks, and storefront extensions, with an OAuth-based install flow that merchants complete in one click.
88+
89+
**When to build an app vs. a direct integration**
90+
91+
- You're distributing your integration to multiple merchants
92+
- Your integration spans both backend logic (Admin API, Webhooks) and storefront UI (snippets, event tracking)
93+
- You need per-store OAuth tokens that merchants can grant and revoke
94+
95+
**Get started**
96+
97+
1. Review the [example apps](#example-apps) to understand the full pattern before writing any code
98+
2. Define your [App Manifest](/docs/apps/manifest.md)
99+
3. Implement the [OAuth install flow](/docs/apps/oauth/getting-started.md)
100+
101+
**Example apps**
102+
103+
| App | What it covers |
104+
| --- | --- |
105+
| [Example S2S App](https://github.com/29next/example-app) | OAuth flow, session tokens, remote settings, webhooks |
106+
| [Google Analytics 4](https://github.com/29next/google-analytics-4) | Snippets and event tracking in storefronts |
107+
| [Fulfillment Service](https://github.com/29next/demo-fulfillment-service-app) | OAuth flow and fulfillment API integration |
108+
109+
**Resources**
110+
- [Apps overview](/docs/apps/)
111+
- [OAuth & install flows](/docs/apps/oauth/)
112+
- [Server-to-server guide](/docs/apps/guides/server-to-server-apps.md)
113+
- [Storefront extension guide](/docs/apps/guides/storefront-extension.md)
114+
- [Webhooks](/docs/webhooks.md)
27115

28-
We can't wait to see what you build! 💪

0 commit comments

Comments
 (0)