Skip to content

Commit b41f1a7

Browse files
committed
update readme
closes #5
1 parent 4844556 commit b41f1a7

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

.env.example

+5-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,8 @@ DISCORD_CLIENT_SECRET=
1010
GITHUB_CLIENT_ID=
1111
GITHUB_CLIENT_SECRET=
1212
GOOGLE_CLIENT_ID=
13-
GOOGLE_CLIENT_SECRET=
13+
GOOGLE_CLIENT_SECRET=
14+
15+
# NOTE:
16+
# In your OAuth2 apps, set callback/redirect URIs to`http://localhost:3000/api/auth/callback/<provider>`
17+
# e.g. http://localhost:3000/api/auth/callback/github

README.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,37 @@ A minimal starter template for 🏝️ TanStack Start.
1919

2020
3. Create a `.env` file based on [`.env.example`](./.env.example).
2121

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:
2523

2624
```bash
2725
pnpm db push # npm run db push
2826
```
2927

3028
https://orm.drizzle.team/docs/migrations
3129

32-
6. Run the development server:
30+
5. Run the development server:
3331

3432
```bash
3533
pnpm dev # npm run dev
3634
```
3735

3836
The development server should be now running at [http://localhost:3000](http://localhost:3000).
3937

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))
4153

4254
## Building for production
4355

@@ -55,6 +67,11 @@ A minimal starter template for 🏝️ TanStack Start.
5567
pnpm start # npm start
5668
```
5769

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+
5875
## Acknowledgements
5976

6077
- [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

Comments
 (0)