first commit
This commit is contained in:
128
TEMPLATE_INFO.md
Normal file
128
TEMPLATE_INFO.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# 模板项目信息
|
||||
|
||||
## 模板来源
|
||||
|
||||
本模板基于 `aitsc` 项目的最佳实践抽取而成,保留了以下核心特性:
|
||||
|
||||
- ✅ 标准化的项目结构
|
||||
- ✅ 多环境配置管理
|
||||
- ✅ 依赖分类管理
|
||||
- ✅ 应用工厂模式
|
||||
- ✅ 完整的测试框架
|
||||
- ✅ 文档结构模板
|
||||
|
||||
## 文件清单
|
||||
|
||||
### 配置文件
|
||||
|
||||
- `.gitignore` - Git忽略文件配置
|
||||
- `.flake8` - flake8代码检查配置
|
||||
- `pytest.ini` - pytest测试配置
|
||||
- `env.example` - 环境变量模板
|
||||
- `gunicorn.conf.py` - Gunicorn生产服务器配置
|
||||
|
||||
### 启动脚本
|
||||
|
||||
- `run_dev.py` - 开发环境启动脚本
|
||||
- `run_production.py` - 生产环境启动脚本(测试用)
|
||||
|
||||
### 配置模块 (`config/`)
|
||||
|
||||
- `__init__.py` - 配置选择器
|
||||
- `base.py` - 基础配置类
|
||||
- `development.py` - 开发环境配置
|
||||
- `production.py` - 生产环境配置
|
||||
- `testing.py` - 测试环境配置
|
||||
- `local.py` - 本地环境配置
|
||||
|
||||
### 源代码 (`src/your_app/`)
|
||||
|
||||
- `__init__.py` - 应用工厂
|
||||
- `app.py` - 应用入口
|
||||
- `models/` - 数据模型
|
||||
- `__init__.py`
|
||||
- `example.py` - 示例模型
|
||||
- `routes/` - 路由定义
|
||||
- `__init__.py` - 主路由蓝图
|
||||
- `services/` - 业务逻辑
|
||||
- `__init__.py`
|
||||
- `utils/` - 工具函数
|
||||
- `__init__.py`
|
||||
- `helpers.py` - 辅助函数
|
||||
- `static/` - 静态资源目录
|
||||
- `templates/` - 模板文件
|
||||
- `base.html` - 基础模板
|
||||
- `index.html` - 首页模板
|
||||
|
||||
### 依赖管理 (`requirements/`)
|
||||
|
||||
- `base.txt` - 基础依赖
|
||||
- `development.txt` - 开发依赖
|
||||
- `production.txt` - 生产依赖
|
||||
- `test.txt` - 测试依赖
|
||||
|
||||
### 测试 (`tests/`)
|
||||
|
||||
- `__init__.py`
|
||||
- `conftest.py` - pytest配置和fixtures
|
||||
- `test_example.py` - 示例测试
|
||||
|
||||
### 文档 (`docs/`)
|
||||
|
||||
- `README.md` - 文档索引
|
||||
- `api/README.md` - API文档模板
|
||||
- `development/README.md` - 开发文档模板
|
||||
- `deployment/README.md` - 部署文档模板
|
||||
|
||||
### 工具脚本 (`scripts/`)
|
||||
|
||||
- `init_project.py` - 项目初始化脚本
|
||||
|
||||
### 文档文件
|
||||
|
||||
- `README.md` - 项目说明
|
||||
- `QUICK_START.md` - 快速开始指南
|
||||
- `PROJECT_STRUCTURE.md` - 项目结构说明
|
||||
- `USAGE.md` - 使用说明
|
||||
- `TEMPLATE_INFO.md` - 本文件
|
||||
|
||||
## 使用方式
|
||||
|
||||
### 方式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
|
||||
# 脚本会引导你完成初始化
|
||||
```
|
||||
|
||||
## 下一步
|
||||
|
||||
1. 查看 [README.md](README.md) 了解完整功能
|
||||
2. 查看 [QUICK_START.md](QUICK_START.md) 快速开始
|
||||
3. 查看 [USAGE.md](USAGE.md) 了解详细使用方法
|
||||
4. 查看 [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) 了解项目结构
|
||||
|
||||
## 版本信息
|
||||
|
||||
- 模板版本: v1.0.0
|
||||
- 创建日期: 2025-01-XX
|
||||
- 基于项目: aitsc
|
||||
- Python版本要求: 3.8+
|
||||
|
||||
## 贡献
|
||||
|
||||
如果你有改进建议,欢迎:
|
||||
1. 提出Issue
|
||||
2. 提交Pull Request
|
||||
3. 分享使用经验
|
||||
|
||||
Reference in New Issue
Block a user