liurenchaxin/PROJECT_STRUCTURE.md

2.9 KiB
Raw Blame History

孢子殖民地项目 - 清理后结构

🎯 根目录(极简版)

孢子殖民地/
├── README.md              # 项目核心介绍
├── LICENSE                # 开源许可证
├── main.py               # 主程序入口
├── ai_collaboration_demo.py  # AI协作演示
├── install.sh            # 一键安装脚本
├── requirements.txt      # Python依赖

├── pytest.ini          # 测试配置
├── .gitignore          # Git忽略规则
├── .gitguardian.yaml   # 安全配置
├── agents/             # AI代理身份系统核心
├── src/               # 核心协作系统源码
├── app/               # Streamlit应用
├── demo_feature/      # 演示功能
├── design/            # 设计文档
├── docs/              # 项目文档
├── examples/          # 使用示例
├── outputs/           # 输出结果
├── tests/             # 测试文件
├── tools/             # 工具脚本
├── website/           # 项目网站
└── modules/           # 模块化组件
    ├── agent-identity/     # AI代理身份模块
    ├── core-collaboration/ # 核心协作模块
    ├── monitoring-dashboard/ # 监控面板模块
    ├── documentation-suite/ # 文档套件模块
    ├── testing-framework/  # 测试框架模块
    ├── devops-tools/      # DevOps工具模块
    └── legacy-support/    # 历史支持文件

📁 核心目录说明

🎯 根目录保留文件

  • main.py: 项目主入口启动AI协作系统
  • ai_collaboration_demo.py: AI协作演示脚本
  • install.sh: 一键安装所有依赖和环境
  • requirements.txt: Python依赖清单

🏗️ 核心系统目录

  • agents/: AI代理身份管理系统
  • src/: 核心协作系统源代码
  • app/: Streamlit Web应用界面
  • tests/: 单元测试和集成测试
  • tools/: 开发工具和实用脚本

📊 项目资产目录

  • docs/: 项目文档和使用指南
  • examples/: 使用示例和演示案例
  • design/: 系统架构和设计文档
  • outputs/: 运行输出和结果存储
  • website/: 项目展示网站

🧩 模块化组件modules/

所有复杂功能和历史文件已迁移到modules目录

  • legacy-support/: 历史文件、报告、临时文件
  • 其他5个模块: 之前创建的模块化组件

🚀 快速开始

# 1. 克隆项目
git clone [项目地址]
cd 孢子殖民地

# 2. 一键安装
./install.sh

# 3. 启动项目
python main.py

# 4. 访问Web界面
streamlit run app/streamlit_app.py

🎯 设计哲学

极简根目录:只保留最核心、最常用的文件 模块化组织复杂功能全部封装到modules目录 清晰边界:核心系统与辅助工具完全分离 易于导航3秒内找到任何文件

现在项目根目录从30+个文件减少到17个清爽多了 🎉