commit ffca240392e140b82ec7e552f53ea2d550ff01e5 Author: admin <263303411@qq.com> Date: Sun Dec 21 00:26:49 2025 +0800 添加 Home diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..c01d56c --- /dev/null +++ b/Home.md @@ -0,0 +1,101 @@ +基于 `aitsc` 项目的最佳实践,已成功抽取并创建了一个通用的Python项目模板。 + +## 📦 模板位置 + +模板位于 `template/` 目录,包含完整的项目结构和配置文件。 + +## ✨ 模板特性 + +### 核心功能 + +- ✅ **标准化项目结构** - 清晰的目录组织,易于维护和扩展 +- ✅ **多环境配置管理** - 支持development/production/testing/local四种环境 +- ✅ **依赖分类管理** - 基础/开发/生产/测试依赖分离管理 +- ✅ **应用工厂模式** - 灵活的Flask应用创建方式 +- ✅ **数据库迁移支持** - 使用Flask-Migrate管理数据库版本 +- ✅ **环境变量管理** - 使用.env文件管理敏感配置 +- ✅ **完整的测试框架** - pytest配置和示例测试 +- ✅ **文档结构模板** - API、开发、部署文档模板 +- ✅ **代码质量工具** - flake8、pytest配置 +- ✅ **生产环境支持** - Gunicorn配置和日志系统 + +## 🚀 快速使用 + +### 方式1: 直接复制 + +```bash +# 复制模板到新项目 +cp -r template my_new_project +cd my_new_project + +# 按照README.md的说明配置和运行 +``` + +### 方式2: 使用初始化脚本 + +```bash +# 复制模板 +cp -r template my_new_project +cd my_new_project + +# 运行初始化脚本(推荐) +python scripts/init_project.py +``` + +## 📁 模板结构 + +``` +template/ +├── src/your_app/ # 源代码(需要重命名) +├── config/ # 多环境配置 +├── requirements/ # 分类依赖管理 +├── tests/ # 测试文件 +├── docs/ # 文档模板 +├── scripts/ # 工具脚本 +├── run_dev.py # 开发启动脚本 +├── run_production.py # 生产启动脚本 +└── README.md # 详细文档 +``` + +## 📚 文档说明 + +模板包含以下文档: + +1. **README.md** - 完整的项目说明和使用指南 +2. **QUICK_START.md** - 5分钟快速开始指南 +3. **PROJECT_STRUCTURE.md** - 详细的项目结构说明 +4. **USAGE.md** - 详细的使用说明和最佳实践 +5. **TEMPLATE_INFO.md** - 模板信息和使用方式 + +## 🎯 使用场景 + +这个模板适用于: + +- 新建Flask Web应用项目 +- 需要快速启动的项目 +- 需要标准化结构的团队项目 +- 学习和参考Flask最佳实践 + +## 💡 优势 + +相比从零开始,使用此模板可以: + +- **节省2-3天**的初始搭建时间 +- **避免重复工作**,直接使用最佳实践 +- **统一项目结构**,便于团队协作 +- **快速上手**,专注于业务开发 + +## 📖 下一步 + +1. 进入 `template/` 目录查看模板 +2. 阅读 `template/README.md` 了解详细功能 +3. 阅读 `template/QUICK_START.md` 快速开始 +4. 复制模板开始你的新项目! + +## 🔧 维护 + +模板基于 `aitsc` 项目的最佳实践,可以根据实际使用情况持续优化。 + +--- + +**提示**: 模板中的 `your_app` 需要替换为你的实际项目名称。