我是开发者
开发环境搭建指南
本指南将帮助您配置5ire项目的本地开发环境并启动运行。
环境配置流程
1. 克隆项目仓库
2. Node.js环境配置
推荐使用asdf版本管理工具。已安装asdf的用户可执行:
也可直接从官网下载安装v20.10.0版本。
3. 安装依赖
激活Python虚拟环境
根据当前shell环境执行对应命令:
安装Node依赖
4. 环境变量配置
在项目根目录创建.env
文件,填入以下配置:
说明:我们通过Axiom采集匿名运行指标,使用Supabase进行授权和设置备份。若开发时无需这些功能,可用占位符配置代替。
获取服务凭证:
-
Axiom凭证:
- 在Axiom创建组织
- 在组织设置中获取组织ID
- 创建新的API令牌
-
Supabase凭证:
- 在Supabase平台创建项目
- 进入项目设置 > API
- 从项目URL提取子域名作为项目ID(示例:
https://xvmubowipwszxgjskdme.supabase.co
的ID为xvmubowipwszxgjskdme
) - 复制
anon
公钥作为SUPA_KEY
值
5. 配置Git钩子 (Husky)
启动开发环境
运行开发服务器
该命令将:
- 以开发模式启动Electron应用
- 启用代码热更新功能
- 自动打开应用窗口
常见问题处理
Supabase连接异常
- 确认
.env
文件中的SUPA_PROJECT_ID
和SUPA_KEY
配置正确 - 确保Supabase项目已启动且可访问
- 确认使用的是开发专用
anon
公钥
Node.js版本异常
Electron启动失败
- 尝试禁用沙箱和GPU加速:
- 检查控制台输出的具体错误信息
开发工作流
- 修改代码后
- 应用将自动热更新(主进程修改需重启生效)
构建生产包
构建完成后将在release/build
目录生成可分发的安装包。