From bc161755945c5b0656bfc3e70b0c38d6af045428 Mon Sep 17 00:00:00 2001 From: Willen Leal Date: Thu, 19 Sep 2024 14:09:25 -0400 Subject: [PATCH] docs(start): clarify running builds locally --- docs/framework/react/start/getting-started.md | 28 +++++++++++++++---- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/framework/react/start/getting-started.md b/docs/framework/react/start/getting-started.md index 240e6b2fa7..103953026b 100644 --- a/docs/framework/react/start/getting-started.md +++ b/docs/framework/react/start/getting-started.md @@ -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: @@ -98,18 +112,20 @@ There are four required files for TanStack Start usage: 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` └── `tsconfig.json` + ``` ## The Router Configuration