create-start-app 0.10.0-alpha.9 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -53
- package/dist/index.js +1 -0
- package/package.json +2 -2
- package/src/index.ts +1 -0
package/README.md
CHANGED
|
@@ -10,25 +10,18 @@ To maintain compatability with `create-react-app` you can build a new applicatio
|
|
|
10
10
|
|
|
11
11
|
| Command | Description |
|
|
12
12
|
| -------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
13
|
-
| `
|
|
14
|
-
| `
|
|
15
|
-
| `npx create-start-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
|
|
16
|
-
| `npx create-start-app@latest my-app --tailwind` | Add Tailwind CSS support |
|
|
17
|
-
| `npx create-start-app@latest my-app --framework solid` | Create a Solid app |
|
|
18
|
-
| `npx create-start-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
|
|
13
|
+
| `pnpx create-start-app@latest my-app` | Create a new app |
|
|
14
|
+
| `pnpx create-start-app@latest my-app --framework solid` | Create a Solid app |
|
|
19
15
|
|
|
20
16
|
If you don't specify a project name, the CLI will walk you through an interactive setup process:
|
|
21
17
|
|
|
22
18
|
```bash
|
|
23
|
-
|
|
19
|
+
pnpx create-start-app@latest
|
|
24
20
|
```
|
|
25
21
|
|
|
26
22
|
This will start an interactive CLI that guides you through the setup process, allowing you to choose:
|
|
27
23
|
|
|
28
24
|
- Project Name
|
|
29
|
-
- Router Type (File-based or Code-based routing)
|
|
30
|
-
- TypeScript support
|
|
31
|
-
- Tailwind CSS integration
|
|
32
25
|
- Package manager
|
|
33
26
|
- Toolchain
|
|
34
27
|
- Git initialization
|
|
@@ -38,13 +31,11 @@ This will start an interactive CLI that guides you through the setup process, al
|
|
|
38
31
|
You can also use command line flags to specify your preferences directly:
|
|
39
32
|
|
|
40
33
|
```bash
|
|
41
|
-
|
|
34
|
+
pnpx create-start-app@latest my-app --tailwind --package-manager pnpm
|
|
42
35
|
```
|
|
43
36
|
|
|
44
37
|
Available options:
|
|
45
38
|
|
|
46
|
-
- `--template <type>`: Choose between `file-router`, `typescript`, or `javascript`
|
|
47
|
-
- `--tailwind`: Enable Tailwind CSS
|
|
48
39
|
- `--package-manager`: Specify your preferred package manager (`npm`, `yarn`, `pnpm`, `bun`, or `deno`)
|
|
49
40
|
- `--toolchain`: Specify your toolchain solution for formatting/linting (`biome`, `eslint+prettier`)
|
|
50
41
|
- `--no-git`: Do not initialize a git repository
|
|
@@ -58,43 +49,13 @@ What you'll get is a Vite application that uses TanStack Router. All the files w
|
|
|
58
49
|
|
|
59
50
|
`create-start-app` is everything you loved about CRA but implemented with modern tools and best practices, on top of the popular TanStack set of libraries. Which includes [@tanstack/react-query](https://tanstack.com/query/latest) and [@tanstack/react-router](https://tanstack.com/router/latest).
|
|
60
51
|
|
|
61
|
-
## Routing Options
|
|
62
|
-
|
|
63
|
-
### File Based Routing (Recommended)
|
|
64
|
-
|
|
65
|
-
File Based Routing is the default option when using the interactive CLI. The location of the home page will be `app/routes/index.tsx`. This approach provides a more intuitive and maintainable way to structure your routes.
|
|
66
|
-
|
|
67
|
-
To explicitly choose File Based Routing, use:
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
npx create-start-app@latest my-app --template file-router
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Code Based Routing
|
|
74
|
-
|
|
75
|
-
If you prefer traditional code-based routing, you can select it in the interactive CLI or specify it by using either the `typescript` or `javascript` template:
|
|
76
|
-
|
|
77
|
-
```bash
|
|
78
|
-
npx create-start-app@latest my-app --template typescript
|
|
79
|
-
```
|
|
80
|
-
|
|
81
52
|
## Additional Configuration
|
|
82
53
|
|
|
83
|
-
### TypeScript
|
|
84
|
-
|
|
85
|
-
- File Based Routing always uses TypeScript
|
|
86
|
-
- For Code Based Routing, you can choose between TypeScript and JavaScript
|
|
87
|
-
- Enable TypeScript explicitly with `--template typescript`
|
|
88
|
-
|
|
89
|
-
### Tailwind CSS
|
|
90
|
-
|
|
91
|
-
Enable Tailwind CSS either through the interactive CLI or by adding the `--tailwind` flag. This will automatically configure [Tailwind V4](https://tailwindcss.com/).
|
|
92
|
-
|
|
93
54
|
### Package Manager
|
|
94
55
|
|
|
95
56
|
Choose your preferred package manager (`npm`, `bun`, `yarn`, `pnpm`, or `deno`) either through the interactive CLI or using the `--package-manager` flag.
|
|
96
57
|
|
|
97
|
-
Extensive documentation on using the TanStack
|
|
58
|
+
Extensive documentation on using the TanStack Start, as well as integrating [@tanstack/react-query](https://tanstack.com/query/latest) and [@tanstack/store](https://tanstack.com/store/latest) can be found in the generated `README.md` for your project.
|
|
98
59
|
|
|
99
60
|
### Toolchain
|
|
100
61
|
|
|
@@ -109,7 +70,7 @@ Setting this flag to `eslint+prettier` will configure it as your toolchain of ch
|
|
|
109
70
|
You can enable add-on selection:
|
|
110
71
|
|
|
111
72
|
```bash
|
|
112
|
-
|
|
73
|
+
pnpx create-start-app@latest --add-ons
|
|
113
74
|
```
|
|
114
75
|
|
|
115
76
|
This will prompt you to select the add-ons you want to enable during application creation.
|
|
@@ -117,29 +78,27 @@ This will prompt you to select the add-ons you want to enable during application
|
|
|
117
78
|
You can enable specific add-ons directly by adding a comma separated list of add-on names to the `--add-ons` flag. For example:
|
|
118
79
|
|
|
119
80
|
```bash
|
|
120
|
-
|
|
81
|
+
pnpx create-start-app@latest my-app --add-ons shadcn,tanstack-query
|
|
121
82
|
```
|
|
122
83
|
|
|
123
84
|
You can get a list of all available add-ons by running:
|
|
124
85
|
|
|
125
86
|
```bash
|
|
126
|
-
|
|
87
|
+
pnpx create-start-app@latest --list-add-ons
|
|
127
88
|
```
|
|
128
89
|
|
|
129
|
-
This will
|
|
90
|
+
This will get you a list of all available add-ons for Solid.
|
|
130
91
|
|
|
131
92
|
```bash
|
|
132
|
-
|
|
93
|
+
pnpx create-start-app@latest --list-add-ons --framework solid
|
|
133
94
|
```
|
|
134
95
|
|
|
135
|
-
Will get you a list of all available add-ons for Solid that are compatible with the File Router.
|
|
136
|
-
|
|
137
96
|
## MCP (Model Context Protocol) Support (experimental)
|
|
138
97
|
|
|
139
|
-
You can launch the `create-start-app` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack
|
|
98
|
+
You can launch the `create-start-app` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack Start applications.
|
|
140
99
|
|
|
141
100
|
```bash
|
|
142
|
-
|
|
101
|
+
pnpx create-start-app@latest --mcp
|
|
143
102
|
```
|
|
144
103
|
|
|
145
104
|
Shown below is the configuration for MCP support in Cursor.
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-start-app",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"description": "Tanstack Start Builder",
|
|
5
5
|
"bin": "./dist/index.js",
|
|
6
6
|
"type": "module",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"author": "Jack Herrington <jherr@pobox.com>",
|
|
23
23
|
"license": "MIT",
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@tanstack/cta-engine": "0.
|
|
25
|
+
"@tanstack/cta-engine": "0.11.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@types/node": "^22.13.4",
|