You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+22-5
Original file line number
Diff line number
Diff line change
@@ -19,25 +19,37 @@ A minimal starter template for 🏝️ TanStack Start.
19
19
20
20
3. Create a `.env` file based on [`.env.example`](./.env.example).
21
21
22
-
4. In your OAuth2 apps, set the callback/redirect URIs to `http://localhost:3000/api/auth/callback/<provider>` (e.g. http://localhost:3000/api/auth/callback/github).
23
-
24
-
5. Push the schema to your database with drizzle-kit:
22
+
4. Push the schema to your database with drizzle-kit:
25
23
26
24
```bash
27
25
pnpm db push # npm run db push
28
26
```
29
27
30
28
https://orm.drizzle.team/docs/migrations
31
29
32
-
6. Run the development server:
30
+
5. Run the development server:
33
31
34
32
```bash
35
33
pnpm dev # npm run dev
36
34
```
37
35
38
36
The development server should be now running at [http://localhost:3000](http://localhost:3000).
39
37
40
-
For other scripts, check the [package.json](./package.json#L5) file.
38
+
## Goodies
39
+
40
+
#### Scripts
41
+
42
+
These scripts in [package.json](./package.json#L5) use pnpm by default, but you can update them to use other package managers if you prefer.
43
+
44
+
-**`auth:generate`** - Regenerate the [auth db schema](./lib/server/schema/auth.schema.ts) if you've made changes to your Better Auth [config](./lib/server/auth.ts).
45
+
-**`db`** - Run drizzle-kit commands. (e.g. `pnpm db generate` to generate a migration)
46
+
-**`ui`** - The shadcn/ui CLI. (e.g. `pnpm ui add button` to add the button component)
47
+
-**`format`** and **`lint`** - Run Prettier and ESLint.
48
+
49
+
#### Utilities
50
+
51
+
-[`auth-guard.ts`](./lib/middleware/auth-guard.ts) - Sample middleware for forcing authentication on server functions. ([see #5](https://github.com/dotnize/tanstarter/issues/5))
52
+
-[`ThemeToggle.tsx`](./lib/components/ThemeToggle.tsx) - A simple component to toggle between light and dark mode. ([#7](https://github.com/dotnize/tanstarter/issues/7))
41
53
42
54
## Building for production
43
55
@@ -55,6 +67,11 @@ A minimal starter template for 🏝️ TanStack Start.
55
67
pnpm start # npm start
56
68
```
57
69
70
+
## Issue watchlist
71
+
72
+
-https://github.com/shadcn-ui/ui/issues/6585 - We're using the `canary` version of shadcn/ui for Tailwind CSS v4 support.
73
+
-https://github.com/lucide-icons/lucide/issues/2743, https://github.com/lucide-icons/lucide/issues/2775 - `lucide-react` is currently locked to 0.470.0 due to crashing deployments.
74
+
58
75
## Acknowledgements
59
76
60
77
-[nekochan0122/tanstack-boilerplate](https://github.com/nekochan0122/tanstack-boilerplate) - A batteries-included TanStack Start boilerplate that inspired some patterns in this template. If you're looking for a more feature-rich starter, check it out!
0 commit comments