Open History to see the last commit
1---
2id: starters
3title: Starters
4---
5
6Starters are reusable presets of add-ons. They capture configuration, not code.
7
8## Use a Starter
9
10```bash
11tanstack create my-app --starter https://example.com/starter.json
12tanstack create my-app --starter ./local-starter.json
13```
14
15## Create a Starter
16
17```bash
18# 1. Create project with desired add-ons
19tanstack create my-preset --add-ons clerk,drizzle,sentry
20
21# 2. Initialize starter
22cd my-preset
23tanstack starter init
24
25# 3. Edit starter-info.json, then compile
26tanstack starter compile
27
28# 4. Use or distribute starter.json
29tanstack create new-app --starter ./starter.json
30```
31
32## Starter Schema
33
34`starter-info.json`:
35
36```json
37{
38 "id": "my-saas",
39 "name": "SaaS Starter",
40 "description": "Auth, database, monitoring",
41 "framework": "react",
42 "mode": "file-router",
43 "typescript": true,
44 "tailwind": true,
45 "addOns": ["clerk", "drizzle", "sentry"],
46 "addOnOptions": {
47 "drizzle": { "database": "postgres" }
48 }
49}
50```
51
52| Field | Required | Description |
53|-------|----------|-------------|
54| `id` | Yes | Unique identifier |
55| `name` | Yes | Display name |
56| `description` | Yes | Brief description |
57| `framework` | Yes | `react` or `solid` |
58| `mode` | Yes | `file-router` or `code-router` |
59| `typescript` | Yes | Enable TypeScript |
60| `tailwind` | Yes | Include Tailwind |
61| `addOns` | Yes | Add-on IDs |
62| `addOnOptions` | No | Per-add-on config |
63| `banner` | No | Image URL for UI |
64
65## Starter vs Add-on
66
67| | Starter | Add-on |
68|-|---------|--------|
69| Contains code | No | Yes |
70| Adds files | No | Yes |
71| Configuration preset | Yes | No |