從零開始建構

Note

若您選擇透過範例或複製專案快速開始，可以跳過本指南並直接前往學習基礎指南。

您想從零開始建立一個 TanStack Start 專案嗎？

本指南將協助您建立一個非常基礎的 TanStack Start 網頁應用程式。我們將一起使用 TanStack Start 來：

提供一個首頁...
該頁面會顯示一個計數器...
並有一個按鈕可持續增加計數器的值。

讓我們建立一個新的專案目錄並初始化它。

shell

mkdir myApp
cd myApp
npm init -y

mkdir myApp
cd myApp
npm init -y

Note

> 我們在這些範例中使用 npm，但您可以改用您喜歡的套件管理工具。

TypeScript 設定

我們強烈建議搭配 TypeScript 使用 TanStack Start。建立一個 tsconfig.json 檔案，至少包含以下設定：

json

{
  "compilerOptions": {
    "jsx": "react-jsx",
    "moduleResolution": "Bundler",
    "module": "ESNext",
    "target": "ES2022",
    "skipLibCheck": true,
    "strictNullChecks": true
  }
}

{
  "compilerOptions": {
    "jsx": "react-jsx",
    "moduleResolution": "Bundler",
    "module": "ESNext",
    "target": "ES2022",
    "skipLibCheck": true,
    "strictNullChecks": true
  }
}

Note

> 啟用 verbatimModuleSyntax 可能導致伺服器套件洩漏至客戶端套件。建議保持此選項關閉。

安裝相依套件

TanStack Start（目前*）由 Vinxi 和 TanStack Router 驅動，並需要它們作為相依套件。

Note

> *Vinxi 將在 1.0.0 版本發布前移除，TanStack 將僅依賴 Vite 和 Nitro。使用 Vinxi 的指令和 API 可能會被 Vite 插件或專用的 TanStack Start CLI 取代。

執行以下指令安裝它們：

shell

npm i @tanstack/react-start @tanstack/react-router vinxi

npm i @tanstack/react-start @tanstack/react-router vinxi

您還需要 React 和 Vite React 插件，因此也安裝它們：

shell

npm i react react-dom
npm i -D @vitejs/plugin-react vite-tsconfig-paths

npm i react react-dom
npm i -D @vitejs/plugin-react vite-tsconfig-paths

以及一些 TypeScript 相關套件：

shell

npm i -D typescript @types/react @types/react-dom

npm i -D typescript @types/react @types/react-dom

更新設定檔案

我們將更新 package.json 以使用 Vinxi 的 CLI 並設定 "type": "module"：

json

{
  // ...
  "type": "module",
  "scripts": {
    "dev": "vinxi dev",
    "build": "vinxi build",
    "start": "vinxi start"
  }
}

{
  // ...
  "type": "module",
  "scripts": {
    "dev": "vinxi dev",
    "build": "vinxi build",
    "start": "vinxi start"
  }
}

然後設定 TanStack Start 的 app.config.ts 檔案：

typescript

// app.config.ts
import { defineConfig } from '@tanstack/react-start/config'
import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
  vite: {
    plugins: [
      tsConfigPaths({
        projects: ['./tsconfig.json'],
      }),
    ],
  },
})

// app.config.ts
import { defineConfig } from '@tanstack/react-start/config'
import tsConfigPaths from 'vite-tsconfig-paths'

export default defineConfig({
  vite: {
    plugins: [
      tsConfigPaths({
        projects: ['./tsconfig.json'],
      }),
    ],
  },
})

加入基本模板

TanStack Start 的使用需要四個必要檔案：

路由設定
伺服器入口點
客戶端入口點
應用程式的根目錄

設定完成後，我們的檔案結構將如下所示：

.
├── app/
│   ├── routes/
│   │   └── `__root.tsx`
│   ├── `client.tsx`
│   ├── `router.tsx`
│   ├── `routeTree.gen.ts`
│   └── `ssr.tsx`
├── `.gitignore`
├── `app.config.ts`
├── `package.json`
└── `tsconfig.json`

.
├── app/
│   ├── routes/
│   │   └── `__root.tsx`
│   ├── `client.tsx`
│   ├── `router.tsx`
│   ├── `routeTree.gen.ts`
│   └── `ssr.tsx`
├── `.gitignore`
├── `app.config.ts`
├── `package.json`
└── `tsconfig.json`

路由設定

這個檔案將決定 Start 中使用的 TanStack Router 的行為。在這裡，您可以設定從預設的預載功能到快取過期的所有內容。

Note

您目前還沒有 routeTree.gen.ts 檔案。這個檔案將在您首次執行 TanStack Start 時生成。

tsx

// app/router.tsx
import { createRouter as createTanStackRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

export function createRouter() {
  const router = createTanStackRouter({
    routeTree,
    scrollRestoration: true,
  })

  return router
}

declare module '@tanstack/react-router' {
  interface Register {
    router: ReturnType<typeof createRouter>
  }
}

// app/router.tsx
import { createRouter as createTanStackRouter } from '@tanstack/react-router'
import { routeTree } from './routeTree.gen'

export function createRouter() {
  const router = createTanStackRouter({
    routeTree,
    scrollRestoration: true,
  })

  return router
}

declare module '@tanstack/react-router' {
  interface Register {
    router: ReturnType<typeof createRouter>
  }
}

伺服器入口點

由於 TanStack Start 是一個伺服器渲染 (SSR) 框架，我們需要將這些路由資訊傳遞到我們的伺服器入口點：

tsx

// app/ssr.tsx
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { getRouterManifest } from '@tanstack/react-start/router-manifest'

import { createRouter } from './router'

export default createStartHandler({
  createRouter,
  getRouterManifest,
})(defaultStreamHandler)

// app/ssr.tsx
import {
  createStartHandler,
  defaultStreamHandler,
} from '@tanstack/react-start/server'
import { getRouterManifest } from '@tanstack/react-start/router-manifest'

import { createRouter } from './router'

export default createStartHandler({
  createRouter,
  getRouterManifest,
})(defaultStreamHandler)

這讓我們能夠在使用者訪問特定路由時知道需要執行哪些路由和載入器。

客戶端入口點

現在我們需要一種方式，在使用者的初始伺服器請求完成後，啟動客戶端的 JavaScript 水合作用。我們通過將相同的路由資訊傳遞到客戶端入口點來實現這一點：

tsx

// app/client.tsx
/// <reference types="vinxi/types/client" />
import { hydrateRoot } from 'react-dom/client'
import { StartClient } from '@tanstack/react-start'
import { createRouter } from './router'

const router = createRouter()

hydrateRoot(document, <StartClient router={router} />)

// app/client.tsx
/// <reference types="vinxi/types/client" />
import { hydrateRoot } from 'react-dom/client'
import { StartClient } from '@tanstack/react-start'
import { createRouter } from './router'

const router = createRouter()

hydrateRoot(document, <StartClient router={router} />)

這讓我們能夠在使用者的初始伺服器請求完成後啟動客戶端路由。

應用程式的根目錄

最後，我們需要建立應用程式的根目錄。這是所有其他路由的入口點。此檔案中的程式碼將包裹應用程式中的所有其他路由。

tsx

// app/routes/__root.tsx
import type { ReactNode } from 'react'
import {
  Outlet,
  createRootRoute,
  HeadContent,
  Scripts,
} from '@tanstack/react-router'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      {
        charSet: 'utf-8',
      },
      {
        name: 'viewport',
        content: 'width=device-width, initial-scale=1',
      },
      {
        title: 'TanStack Start Starter',
      },
    ],
  }),
  component: RootComponent,
})

function RootComponent() {
  return (
    <RootDocument>
      <Outlet />
    </RootDocument>
  )
}

function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
  return (
    <html>
      <head>
        <HeadContent />
      </head>
      <body>
        {children}
        <Scripts />
      </body>
    </html>
  )
}

// app/routes/__root.tsx
import type { ReactNode } from 'react'
import {
  Outlet,
  createRootRoute,
  HeadContent,
  Scripts,
} from '@tanstack/react-router'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      {
        charSet: 'utf-8',
      },
      {
        name: 'viewport',
        content: 'width=device-width, initial-scale=1',
      },
      {
        title: 'TanStack Start Starter',
      },
    ],
  }),
  component: RootComponent,
})

function RootComponent() {
  return (
    <RootDocument>
      <Outlet />
    </RootDocument>
  )
}

function RootDocument({ children }: Readonly<{ children: ReactNode }>) {
  return (
    <html>
      <head>
        <HeadContent />
      </head>
      <body>
        {children}
        <Scripts />
      </body>
    </html>
  )
}

撰寫您的第一個路由

現在我們已經完成了基本模板的設定，可以撰寫我們的第一個路由了。這需要在 app/routes 目錄中建立一個新檔案。

tsx

// app/routes/index.tsx
import * as fs from 'node:fs'
import { createFileRoute, useRouter } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/react-start'

const filePath = 'count.txt'

async function readCount() {
  return parseInt(
    await fs.promises.readFile(filePath, 'utf-8').catch(() => '0'),
  )
}

const getCount = createServerFn({
  method: 'GET',
}).handler(() => {
  return readCount()
})

const updateCount = createServerFn({ method: 'POST' })
  .validator((d: number) => d)
  .handler(async ({ data }) => {
    const count = await readCount()
    await fs.promises.writeFile(filePath, `${count + data}`)
  })

export const Route = createFileRoute('/')({
  component: Home,
  loader: async () => await getCount(),
})

function Home() {
  const router = useRouter()
  const state = Route.useLoaderData()

  return (
    <button
      type="button"
      onClick={() => {
        updateCount({ data: 1 }).then(() => {
          router.invalidate()
        })
      }}
    >
      將 {state} 加 1？
    </button>
  )
}

// app/routes/index.tsx
import * as fs from 'node:fs'
import { createFileRoute, useRouter } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/react-start'

const filePath = 'count.txt'

async function readCount() {
  return parseInt(
    await fs.promises.readFile(filePath, 'utf-8').catch(() => '0'),
  )
}

const getCount = createServerFn({
  method: 'GET',
}).handler(() => {
  return readCount()
})

const updateCount = createServerFn({ method: 'POST' })
  .validator((d: number) => d)
  .handler(async ({ data }) => {
    const count = await readCount()
    await fs.promises.writeFile(filePath, `${count + data}`)
  })

export const Route = createFileRoute('/')({
  component: Home,
  loader: async () => await getCount(),
})

function Home() {
  const router = useRouter()
  const state = Route.useLoaderData()

  return (
    <button
      type="button"
      onClick={() => {
        updateCount({ data: 1 }).then(() => {
          router.invalidate()
        })
      }}
    >
      將 {state} 加 1？
    </button>
  )
}

就是這樣！🤯 您現在已經設定了一個 TanStack Start 專案並撰寫了您的第一個路由。🎉

現在您可以執行 npm run dev 來啟動您的伺服器，並導航至 http://localhost:3000 查看您的路由運作情況。

想要部署您的應用程式嗎？請查看託管指南。

TypeScript 設定

安裝相依套件

更新設定檔案

加入基本模板

路由設定

伺服器入口點

客戶端入口點

應用程式的根目錄

撰寫您的第一個路由

Subscribe to Bytes

Subscribe to Bytes