步骤1:阅读README.md
- 下载项目代码(可通过 GitHub 下载 ZIP 包解压)
- 仔细查看本地应用的访问地址
步骤2:安装 Docker
- 访问 Docker 官网
- 安装提示下载并安装Docker Desktop
步骤3:准备配置文件
-
在项目根目录找到
example.env.server
,重命名为.env.server
注意: 文件名前面有一个点(
.
)这个文件包含了启动这个应用所需要的一些重要设置,特别是与 GitHub 登录相关的密钥。
-
用一个文本编辑器打开你刚刚重命名的
.env.server
文件。 -
修改文件内容
G_CLIENT_ID= G_CLIENT_SECRET= JWT_SECRET= INIT_TABLE=true ENABLE_CACHE=true
G_CLIENT_ID=
和G_CLIENT_SECRET=
这是什么? 这两个是你在 GitHub 上为这个应用程序创建 OAuth App 后得到的凭证,用于让用户通过 GitHub 账号登录你的应用。
如何获取?
-
访问 GitHub 开发者设置页面:在你的 GitHub 头像下拉菜单 -> Settings -> 左侧菜单最下方找到 Developer settings -> 选择 OAuth Apps。
-
点击 “New OAuth App”(新建 OAuth 应用)。
-
填写内容:
Application name: 项目名字
Homepage URL: 查看README.md,填入本地应用的访问地址
Authorization callback URL: 这是用户在 GitHub 授权后,GitHub 跳转回你应用的地址。这个地址一般是
http://localhost:[你的端口]/api/auth/callback/github
(再次核对README.md或代码确认,这个地址是 Node.js + Passport.js 组合的常见回调地址)。如果填错,登录会失败。 -
点击 “Register application”(注册应用)。
-
注册成功后,页面会显示 “Client ID”,复制粘贴到
G_CLIENT_ID=
的后面 -
在"Client secrets" 部分,点击 “Generate a new client secret”(生成新的客户端密钥)。GitHub 会生成一个密钥,复制粘贴到
G_CLIENT_SECRET=
的后面。
JWT_SECRET=
登录token,建议使用在线的密码生成器或询问AI生成一个长 32 个字符或更长、包含大小写字母、数字和符号的随机字符串。
-
-
Ctrl + S
保存文件
步骤4:启动服务
按照README.md的后续步骤,Win+R
打开终端,进入项目目录,运行 docker compose up
来启动服务.
步骤5:访问应用
浏览器打开 http://localhost:[你的端口]
即可使用。