Sistine Starter

安装

如何安装和启动 Sistine Starter

安装

本指南将帮助你在本地环境中安装和运行 Sistine Starter。

系统要求

在开始之前,请确保你的系统满足以下要求:

  • Node.js: >= 18.17.0
  • pnpm: >= 8.0.0 (推荐) 或 npm/yarn/bun
  • PostgreSQL: >= 14.0
  • Git: 最新版本

安装步骤

1. 获取项目访问权限

访问 Sistine 项目申请 填写你的 GitHub 用户名,自动获得项目仓库权限。

2. 克隆仓库

git clone https://github.com/your-org/sistine-starter.git
cd sistine-starter

3. 安装依赖

你可以使用以下任一包管理器:

pnpm install

推荐使用 pnpm,它更快且更节省磁盘空间。

4. 配置环境变量

复制示例环境变量文件:

cp .env.example .env.local

编辑 .env.local 文件,填入必需的环境变量。

环境变量配置指南:

5. 设置数据库

确保你已经安装并运行了 PostgreSQL。推荐使用云服务 Neon(无服务器 PostgreSQL,按需付费)。

.env.local 中配置数据库连接字符串:

DATABASE_URL="postgresql://user:password@host/database?sslmode=require"

6. 运行数据库迁移

首次运行时,需要创建数据库表:

pnpm db:push

提示: db:push 会直接同步 schema 到数据库,适合开发环境。生产环境建议使用 db:migrate

7. 启动开发服务器

pnpm dev

开发服务器将在 http://localhost:3000 启动。

验证安装

打开浏览器访问 http://localhost:3000,你应该能看到 Sistine Starter 的首页。

尝试以下操作验证安装:

  1. 注册账户: 访问 /sign-up 创建新账户
  2. 查看积分: 注册后应自动获得 300 积分
  3. 访问仪表板: 登录后访问 /dashboard

常见问题

安装依赖时出错

如果使用 pnpm 时遇到问题,尝试清理缓存:

pnpm store prune
rm -rf node_modules
pnpm install

数据库连接失败

检查以下内容:

  1. PostgreSQL 服务是否正在运行
  2. DATABASE_URL 格式是否正确
  3. 数据库用户是否有足够权限
  4. 防火墙是否阻止了连接

环境变量未生效

确保:

  1. 文件名为 .env.local (注意前面的点)
  2. 重启开发服务器
  3. 环境变量值没有多余的引号或空格

端口 3000 已被占用

修改启动端口:

PORT=3001 pnpm dev

下一步