Skip to content

PROJECT_STRUCTURE.md

Latest commit

 

History

History
219 lines (183 loc) · 6.33 KB

PROJECT_STRUCTURE.md

File metadata and controls

219 lines (183 loc) · 6.33 KB

Python Web AI 开发教程 - 项目结构

📁 项目目录结构

python_learning/
├── README.md                    # 项目主说明文档
├── PROJECT_STRUCTURE.md         # 项目结构说明（本文件）
├── start_docsify.sh            # Docsify 启动脚本
├── learning_progress.md        # 学习进度跟踪
├── python_web_ai_roadmap.md    # 学习路线图
│
├── docs/                       # 📚 文档系统目录
│   ├── README.md              # 文档首页
│   ├── preface.md             # 前言
│   ├── _sidebar.md            # 侧边栏导航
│   ├── _coverpage.md          # 封面页面
│   ├── index.html             # Docsify 配置文件
│   ├── test.html              # 测试页面
│   │
│   ├── chapter1/              # 第一章：Web 开发基础
│   │   ├── README.md          # 章节目录
│   │   ├── 1.1-http-basics.md # HTTP 协议基础
│   │   ├── 1.2-web-frameworks.md
│   │   ├── 1.3-frontend-backend.md
│   │   └── 1.4-practice-project.md
│   │
│   ├── chapter2/              # 第二章：后端开发进阶
│   │   ├── README.md          # 章节目录
│   │   ├── 2.1-fastapi-advanced.md
│   │   ├── 2.2-database.md
│   │   ├── 2.3-api-design.md
│   │   ├── 2.4-authentication.md
│   │   └── 2.5-practice-project.md
│   │
│   ├── chapter3/              # 第三章：前端开发
│   │   ├── README.md
│   │   ├── 3.1-vue-basics.md
│   │   ├── 3.2-components.md
│   │   ├── 3.3-state-management.md
│   │   ├── 3.4-routing.md
│   │   └── 3.5-practice-project.md
│   │
│   ├── chapter4/              # 第四章：AI 模型集成
│   │   ├── README.md
│   │   ├── 4.1-model-serving.md
│   │   ├── 4.2-async-processing.md
│   │   ├── 4.3-performance.md
│   │   ├── 4.4-model-management.md
│   │   └── 4.5-practice-project.md
│   │
│   ├── chapter5/              # 第五章：部署与运维
│   │   ├── README.md
│   │   ├── 5.1-docker.md
│   │   ├── 5.2-nginx.md
│   │   ├── 5.3-monitoring.md
│   │   ├── 5.4-security.md
│   │   └── 5.5-practice-project.md
│   │
│   └── chapter6/              # 第六章：实战项目
│       ├── README.md
│       ├── 6.1-architecture.md
│       ├── 6.2-development.md
│       ├── 6.3-testing.md
│       ├── 6.4-deployment.md
│       └── 6.5-summary.md
│
├── quick_start_project/        # 🚀 快速开始项目
│   ├── README.md              # 项目说明
│   ├── main.py                # 主程序
│   ├── requirements.txt       # 依赖包
│   ├── start.sh               # 启动脚本
│   └── frontend/              # 前端文件
│       ├── index.html
│       ├── style.css
│       └── script.js
│
└── complete_tutorial/         # 📖 完整教程项目
    ├── README.md              # 教程说明
    ├── requirements.txt       # 依赖包
    ├── learning_checklist.md  # 学习检查清单
    ├── stage1/                # 第一阶段项目
    ├── stage2/                # 第二阶段项目
    ├── stage3/                # 第三阶段项目
    └── final_project/         # 最终项目

🎯 参考项目结构

本项目参考了 Happy-LLM 项目的优秀结构：

相似之处

  1. 📚 文档组织

    • 使用 docsify 构建文档系统
    • 章节化的内容组织
    • 清晰的导航结构

  2. 🎯 学习路径

    • 循序渐进的学习设计
    • 理论与实践相结合
    • 项目驱动的学习方式

  3. 💻 技术栈

    • 现代化的技术选择
    • 完整的开发工具链
    • 开源友好的架构

  4. 📖 内容质量

    • 详细的理论讲解
    • 丰富的代码示例
    • 实用的项目实践

特色改进

  1. 🤖 AI 集成

    • 专注于 AI 模型与 Web 的集成
    • 从模型训练到部署的完整流程
    • 实用的 AI 应用场景

  2. 🔧 技术栈更新

    • 使用 FastAPI 替代传统框架
    • Vue.js 3.0 现代化前端
    • Docker 容器化部署

  3. 📱 用户体验

    • 响应式设计
    • 移动端优化
    • 交互式学习体验

🚀 快速开始

1. 启动文档系统

# 使用启动脚本
./start_docsify.sh

# 或手动启动
npm install -g docsify-cli
cd docs
docsify serve . --port 3000 --open

2. 运行快速开始项目

cd quick_start_project
pip install -r requirements.txt
python main.py

3. 开始学习

  1. 阅读 前言 了解项目背景
  2. 按照章节顺序学习
  3. 完成每个阶段的实践项目
  4. 记录学习进度

📋 开发计划

第一阶段：基础架构 ✅

  • 项目结构设计
  • 文档系统搭建
  • 基础内容编写
  • 启动脚本创建

第二阶段：内容完善 🔄

  • 完善所有章节内容
  • 添加更多代码示例
  • 创建实践项目文档
  • 优化文档样式

第三阶段：功能增强 ⏳

  • 添加搜索功能
  • 集成代码高亮
  • 添加交互式示例
  • 移动端优化

第四阶段：社区建设 ⏳

  • 收集用户反馈
  • 完善常见问题
  • 建立学习社区
  • 持续更新维护

🤝 贡献指南

内容贡献

  1. Fork 本仓库
  2. 创建特性分支
  3. 编写或修改内容
  4. 提交 Pull Request

代码贡献

  1. 遵循代码规范
  2. 添加必要的注释
  3. 编写测试用例
  4. 更新相关文档

问题反馈

  1. 使用 Issue 模板
  2. 详细描述问题
  3. 提供复现步骤
  4. 附上相关日志

📞 联系方式

Star History

Star History Chart

最后更新: 2024年12月 项目状态: 基础架构完成，内容编写中