Docs
开发手册

开发手册

如何快速开始 WR.DO

English

简体中文

创建项目

首先使用 create-next-app 创建一个新的 Next.js 项目:

npx create-next-app wrdo --example "https://github.com/oiov/wr.do"

或者使用 Vercel 部署:

使用 Vercel 部署

这是一种创建代码仓库的好方法,但是部署可能会失败, 因为你需要在本地项目中添加环境变量。请按照文档进行设置。

安装依赖

进入文件夹并为项目安装依赖项:

cd wrdo
pnpm install

创建 .env 文件

.env.example 内容复制粘贴到 .env 文件中:

环境变量描述
NEXTAUTH_URLhttp://localhost:3000Next.js 应用的 URL。
AUTH_SECRET123465用于加密令牌和邮件验证哈希的密钥。
DATABASE_URLpostgres://username:password@host:port/databasePostgres 数据库的路径。
GOOGLE_CLIENT_ID123465Google OAuth 客户端的 ID。
GOOGLE_CLIENT_SECRET123465Google OAuth 客户端的密钥。
GITHUB_ID123465GitHub OAuth 客户端的 ID。
GITHUB_SECRET123465GitHub OAuth 客户端的密钥。
RESEND_API_KEY123465Resend 的 API 密钥。
RESEND_FROM_EMAIL"you <support@your-domain.com>"用于发送邮件的邮箱地址。
NEXT_PUBLIC_OPEN_SIGNUP1开放注册。
SCREENSHOTONE_BASE_URLhttps://api.example.com待补充
GITHUB_TOKENghp_sscsfarwetqethttps://github.com/settings/tokens
  • 如何获取 GOOGLE_CLIENT_IDGITHUB_ID,请参见 认证
  • 如何获取 RESEND_API_KEY,请参见 邮件
  • 如何启用邮件 worker,请参见 邮件 Worker

如需逐步安装说明,请参见 快速开始

配置部分

在使用 pnpm run dev 之前,请确保检查配置部分并更新所有环境变量。