Skip to content

Commit 41739ed

Browse files
committed
Updating the README and logo
1 parent 442a775 commit 41739ed

File tree

4 files changed

+93
-14
lines changed

4 files changed

+93
-14
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ dist
33
app-js
44
app-ts
55
app-js-tw
6-
app-ts-tw
6+
app-ts-tw
7+
.DS_Store

README.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,46 @@
22

33
This CLI applications builds Tanstack Start applications that are the functional equivalent of [Create React App](https://create-react-app.dev/).
44

5-
# Development
5+
To help accelerate the migration away from create-react-app we created the create-tsrouter-app CLI which is a plug-n-play replacement for CRA.
6+
7+
Instead of:
8+
9+
```bash
10+
npx create-react-app my-app
11+
```
12+
13+
You can now run:
614

715
```bash
8-
pnpm i
9-
pnpm build
16+
npx create-tsrouter-app my-app
1017
```
1118

12-
# Manual testing
19+
Instead of using:
20+
21+
```bash
22+
npx create-react-app my-app --template typescript
23+
```
24+
25+
To create a SPA application using TypeScript. You can now run:
26+
27+
```bash
28+
npx create-tsrouter-app my-app --template typescript
29+
```
30+
31+
What you'll get is a Vite application that uses TanStack Router. All the files will still be in the same place as in CRA, but you'll get a fully functional Router setup under in `app/main.tsx`.
32+
33+
`create-tsrouter-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).
34+
35+
If you want Tailwind then just add `--tailwind`.
36+
37+
You can also specify your preferred package manager with `--package-manager` such as `npm`, `bun`, `yarn`, or `pnpm`.
38+
39+
Extensive documentation on using the TanStack Router, migrating to a File Base Routing approach, as well as integrating [@tanstack/react-query](https://tanstack.com/query/latest) and [React-Store](https://tanstack.com/store/latest) be found in the generated `README.md` for your project.
40+
41+
# Contributing
42+
43+
Check out the [Contributing](CONTRIBUTING.md) guide.
1344

14-
| Command | Description |
15-
| ------------------------------------------------------- | ------------------------------------------ |
16-
| `pnpm start app-js` | Creates a JavaScript app |
17-
| `pnpm start app-ts --template typescript` | Creates a TypeScript app |
18-
| `pnpm start app-js-tw --tailwind` | Creates a JavaScript app with Tailwind CSS |
19-
| `pnpm start app-ts-tw --template typescript --tailwind` | Creates a TypeScript app with Tailwind CSS |
45+
# License
2046

21-
There is also `--package-manager pnpm` that will use [pnpm](https://pnpm.io/) as the package manager (this supports `yarn`, `bun`, and `npm` as well).
47+
MIT

package.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-tsrouter-app",
3-
"version": "0.0.2",
3+
"version": "0.0.3",
44
"description": "Tanstack Application Builder",
55
"bin": "./dist/index.js",
66
"type": "module",
@@ -11,6 +11,15 @@
1111
"cipublish": "node scripts/publish.js",
1212
"test:lint": "eslint ./src"
1313
},
14+
"repository": {
15+
"type": "git",
16+
"url": "https://github.com/TanStack/create-tsrouter-app.git"
17+
},
18+
"homepage": "https://tanstack.com/router",
19+
"funding": {
20+
"type": "github",
21+
"url": "https://github.com/sponsors/tannerlinsley"
22+
},
1423
"keywords": [
1524
"react",
1625
"tanstack",

project-template/src/logo.svg

Lines changed: 44 additions & 1 deletion
Loading

0 commit comments

Comments
 (0)