入门

使用 Supabase 与 TanStack Start

了解如何创建一个 Supabase 项目，向你的数据库添加一些示例数据，并从 TanStack Start 应用程序查询这些数据。

1

创建一个 Supabase 项目

前往 database.new 并创建一个新的 Supabase 项目。

或者，您可以使用管理 API 创建项目

1
# First, get your access token from https://supabase.org.cn/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
4
# List your organizations to get the organization ID
5
curl -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
6
  https://api.supabase.com/v1/organizations
7
8
# Create a new project (replace <org-id> with your organization ID)
9
curl -X POST https://api.supabase.com/v1/projects \
10
  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
11
  -H "Content-Type: application/json" \
12
  -d '{
13
    "organization_id": "<org-id>",
14
    "name": "My Project",
15
    "region": "us-east-1",
16
    "db_pass": "<your-secure-password>"
17
  }'

当您的项目启动并运行时，前往 表格编辑器，创建一个新表格并插入一些数据。

或者，您可以在项目的 SQL 编辑器 中运行以下代码片段。这将创建一个包含一些示例数据的 instruments 表。

1
-- Create the table
2
create table instruments (
3
  id bigint primary key generated always as identity,
4
  name text not null
5
);
6
-- Insert some sample data into the table
7
insert into instruments (name)
8
values
9
  ('violin'),
10
  ('viola'),
11
  ('cello');
12
13
alter table instruments enable row level security;

通过添加 RLS 策略使表格中的数据可公开读取

1
create policy "public can read instruments"
2
on public.instruments
3
for select to anon
4
using (true);
2

创建一个 TanStack Start 应用程序

  • 使用官方 CLI 创建一个 TanStack Start 应用程序。

终端
1
npm create @tanstack/start@latest my-app -- --package-manager npm --toolchain biome
3

安装 Supabase 客户端库

开始的最快方法是使用 supabase-js 客户端库，它提供了一个方便的接口，用于从 TanStack Start 应用程序中使用 Supabase。

导航到 TanStack Start 应用程序并安装 supabase-js。

终端
1
cd my-app && npm install @supabase/supabase-js
4

声明 Supabase 环境变量

在项目的根目录下创建一个 .env 文件，并填充你的 Supabase 连接变量

项目 URL
可发布密钥
匿名密钥
1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

你还可以从 项目的 连接 对话框 获取项目 URL 和密钥。

阅读 API 密钥文档 以全面了解所有密钥类型及其用途。

5

创建一个 Supabase 客户端工具

在 src/utils/supabase.ts 创建一个新文件来初始化 Supabase 客户端。

src/utils/supabase.ts
1
import { createClient } from "@supabase/supabase-js";
2
3
export const supabase = createClient(
4
  import.meta.env.VITE_SUPABASE_URL,
5
  import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
6
);
6

从应用查询数据

替换 src/routes/index.tsx 的内容为以下代码，以添加一个加载器函数，该函数获取乐器数据并在页面上显示它。

src/routes/index.tsx
1
import { createFileRoute } from '@tanstack/react-router'
2
import { supabase } from '../utils/supabase'
3
4
export const Route = createFileRoute('/')({
5
  loader: async () => {
6
    const { data: instruments } = await supabase.from('instruments').select()
7
    return { instruments }
8
  },
9
  component: Home,
10
})
11
12
function Home() {
13
  const { instruments } = Route.useLoaderData()
14
15
  return (
16
    <ul>
17
      {instruments?.map((instrument) => (
18
        <li key={instrument.name}>{instrument.name}</li>
19
      ))}
20
    </ul>
21
  )
22
}
7

启动应用

运行开发服务器，在浏览器中访问 https://:3000，你应该会看到乐器列表。

终端
1
npm run dev

下一步#