Skip to content

Commit

Permalink
docs(start): clarify running builds locally
Browse files Browse the repository at this point in the history
  • Loading branch information
willenleal committed Sep 19, 2024
1 parent 5eff361 commit 02e02c5
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/framework/react/start/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,20 @@ import { defineConfig } from '@tanstack/start/config'
export default defineConfig({})
```

> [!NOTE]
> Vercel is set as the default deployment platform. To run builds locally, switch the deployment configuration to your local runtime."
> ```typescript
> // app.config.ts
> import { defineConfig } from '@tanstack/start/config'
>
> export default defineConfig({
> deployment: {
> preset: 'node-server',
> },
> })
> ```
## Add the Basic Templating
There are four required files for TanStack Start usage:
Expand All @@ -100,12 +114,12 @@ Once configuration is done, we'll have a file tree that looks like the following
```
.
├── app/
├── routes/
└── `__root.tsx`
├── `client.tsx`
├── `router.tsx`
├── `routeTree.gen.ts`
└── `ssr.tsx`
│ ├── routes/
└── `__root.tsx`
│ ├── `client.tsx`
│ ├── `router.tsx`
│ ├── `routeTree.gen.ts`
│ └── `ssr.tsx`
├── `.gitignore`
├── `app.config.ts`
├── `package.json`
Expand Down

0 comments on commit 02e02c5

Please sign in to comment.