重整项目文档目录结构
This commit is contained in:
98
docs/README.md
Normal file
98
docs/README.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# 提示词大师 (Prompt Master)
|
||||
|
||||
## 项目概述
|
||||
|
||||
提示词大师是一个基于Flask的Web应用,专门用于管理和优化大模型提示词。该平台提供了提示词的创建、编辑、测试和分享功能,帮助用户更好地利用大语言模型的能力。
|
||||
|
||||
## 主要功能
|
||||
|
||||
- **提示词管理**: 创建、编辑、分类和搜索提示词
|
||||
- **模板系统**: 提供多种行业和场景的提示词模板
|
||||
- **测试功能**: 实时测试提示词效果
|
||||
- **用户系统**: 用户注册、登录和权限管理
|
||||
- **分享功能**: 提示词分享和协作
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **后端**: Python Flask
|
||||
- **数据库**: SQLite/PostgreSQL
|
||||
- **前端**: HTML/CSS/JavaScript
|
||||
- **模板引擎**: Jinja2
|
||||
- **ORM**: SQLAlchemy
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Python 3.8+
|
||||
- pip
|
||||
|
||||
### 安装步骤
|
||||
|
||||
1. 克隆项目
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd aitsc
|
||||
```
|
||||
|
||||
2. 创建虚拟环境
|
||||
```bash
|
||||
python -m venv .venv
|
||||
.venv\Scripts\activate # Windows
|
||||
# source .venv/bin/activate # Linux/Mac
|
||||
```
|
||||
|
||||
3. 安装依赖
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. 初始化数据库
|
||||
```bash
|
||||
python init_db.py
|
||||
```
|
||||
|
||||
5. 运行应用
|
||||
```bash
|
||||
python run_dev.py
|
||||
```
|
||||
|
||||
访问 http://localhost:5000 开始使用
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
aitsc/
|
||||
├── src/flask_prompt_master/ # 主应用代码
|
||||
├── config/ # 配置文件
|
||||
├── tests/ # 测试文件
|
||||
├── docs/ # 项目文档
|
||||
├── scripts/ # 管理脚本
|
||||
└── requirements.txt # 依赖文件
|
||||
```
|
||||
|
||||
## 文档导航
|
||||
|
||||
- [API文档](api/) - API接口说明
|
||||
- [部署文档](deployment/) - 部署和运维指南
|
||||
- [开发文档](development/) - 开发环境搭建和贡献指南
|
||||
- [用户文档](user/) - 用户使用手册
|
||||
|
||||
## 贡献指南
|
||||
|
||||
欢迎贡献代码!请查看 [开发文档](development/contributing.md) 了解详细的贡献流程。
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 MIT 许可证。
|
||||
|
||||
## 联系方式
|
||||
|
||||
如有问题或建议,请通过以下方式联系:
|
||||
|
||||
- 项目Issues: [GitHub Issues](https://github.com/your-repo/issues)
|
||||
- 邮箱: your-email@example.com
|
||||
|
||||
---
|
||||
|
||||
*最后更新: 2024年8月16日*
|
||||
Reference in New Issue
Block a user