从零开始构建项目

注意

如果您选择使用示例或克隆项目快速开始，则可以跳过本指南，直接进入Learn the Basics指南。

所以您想从零开始构建 TanStack Start 项目？

本指南将帮助您构建一个非常基础的 TanStack Start Web 应用程序。我们将一起使用 TanStack Start 来

提供一个索引页面...
其中显示一个计数器...
带有一个按钮以持久性地增加计数器。

让我们创建一个新的项目目录并初始化它。

shell

mkdir myApp
cd myApp
npm init -y

mkdir myApp
cd myApp
npm init -y

注意

> 在所有这些示例中，我们都使用 npm，但您可以改用您选择的包管理器。

TypeScript 配置

我们强烈建议将 TypeScript 与 TanStack Start 一起使用。创建一个 tsconfig.json 文件，其中至少包含以下设置

jsonc

{
  "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,
  },
}

注意

> 启用 verbatimModuleSyntax 可能会导致服务器捆绑包泄漏到客户端捆绑包中。建议禁用此选项。

安装依赖

TanStack Start 目前（*当前）由 Vinxi 和 TanStack Router 提供支持，并且需要它们作为依赖项。

注意

> *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 的行为。在这里，您可以配置从默认预加载功能到缓存过期时间的所有内容。

注意

您还没有 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()
        })
      }}
    >
      Add 1 to {state}?
    </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()
        })
      }}
    >
      Add 1 to {state}?
    </button>
  )
}

就是这样！🤯 您现在已经设置了一个 TanStack Start 项目并编写了您的第一个路由。🎉

您现在可以运行 npm run dev 来启动您的服务器并导航到 https://127.0.0.1:3000 以查看您的路由运行效果。

您想部署您的应用程序吗？请查看托管指南。

TypeScript 配置

安装依赖

更新配置文件

添加基本模板

路由配置

服务端入口点

客户端入口点

应用根目录

编写您的第一个路由

订阅 Bytes

订阅 Bytes