blob: 88a6a873ad431c93744c2ca5818ca46abefdfd96 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
快速开始
========
本页说明本地开发的基本流程：安装依赖、准备环境变量、启动数据库、运行应用和构建文档。
准备工具
--------
需要安装：
* Node.js，版本需满足 Next.js 15；
* pnpm 10.x；
* Docker 或 Podman，用于本地 PostgreSQL；
* Git；
* 可选：Sphinx，用于本地构建文档。
环境变量
--------
复制示例文件：
.. code-block:: bash
cp .env.example .env
环境变量由 ``src/env.js`` 通过 ``@t3-oss/env-nextjs`` 和 ``zod`` 校验。只做本地 UI 或文档调试时，可以临时使用 ``SKIP_ENV_VALIDATION=1``，但生产环境不应依赖它。
数据库
------
启动本地 PostgreSQL：
.. code-block:: bash
./start-database.sh
数据库可用后，按需要运行：
.. code-block:: bash
pnpm payload:migrate
pnpm db:push
运行项目
--------
.. code-block:: bash
pnpm install
pnpm dev
公开站点默认位于 ``http://localhost:3000``，Payload 后台位于 ``/admin``。
常用检查
--------
.. list-table::
:header-rows: 1
:widths: 24 50
* - 命令
- 作用
* - ``pnpm lint``
- 校验内容链接并运行 Biome lint。
* - ``pnpm check``
- 运行 Biome 检查。
* - ``pnpm test``
- 运行 Vitest 测试。
* - ``pnpm build``
- 构建 Next.js 应用并生成站点地图。
* - ``make -C Documentation html``
- 构建 Sphinx 文档。
|
