Skip to content

快速入门指南

环境要求

开始之前,请确保已安装以下软件:

  • Python 2.7+
  • Node.js 23+
  • pnpm
  • Git
  • 代码编辑器(推荐使用 VS Code)

开发环境设置

1. 克隆仓库

bash
git clone https://github.com/focai-acc/focEliza.git
cd focEliza

2. 安装依赖

bash
pnpm install

3. 配置环境

bash
cp .env.example .env
# 编辑 .env 文件设置你的配置

4. 启动开发服务器

bash
pnpm dev

核心概念

TEE 集成

  • 安全执行环境
  • 数据加密
  • 状态验证

插件系统

  • 模块化架构
  • 自定义插件开发
  • 事件系统

区块链集成

  • 智能合约交互
  • 状态同步
  • 交易管理

开发工作流

  1. Fork 和克隆

    • Fork 仓库
    • 本地克隆
    • 设置远程仓库
  2. 分支

    • 创建功能分支
    • 遵循命名规范
    • 保持分支专注
  3. 开发

    • 编写清晰代码
    • 遵循代码风格
    • 添加测试
  4. 测试

    • 运行单元测试
    • 集成测试
    • 手动测试
  5. 提交

    • 创建拉取请求
    • 编写清晰描述
    • 引用相关问题

最佳实践

代码风格

  • 遵循 TypeScript 指南
  • 使用 ESLint 配置
  • 编写清晰注释
  • 文档化公共 API

测试

  • 编写单元测试
  • 集成测试
  • 必要时进行端到端测试
  • 维护测试覆盖率

Git 工作流

  • 清晰的提交信息
  • 原子提交
  • 定期变基
  • 清晰的历史记录

故障排除

常见问题

  1. 构建失败

    • 检查 Node.js 版本
    • 清理 node_modules
    • 重建依赖
  2. TEE 问题

    • 验证硬件支持
    • 检查驱动安装
    • 检查安全设置
  3. 插件问题

    • 检查依赖
    • 验证初始化
    • 调试事件流

获取帮助

  • 查看文档
  • 搜索现有问题
  • 创建详细的错误报告

下一步

Released under the MIT License.