update README
This commit is contained in:
parent
98e82d75bd
commit
8a0925ec1a
121
README.md
121
README.md
@ -1,23 +1,108 @@
|
||||
# 配置中心开发
|
||||
基于fastapi开发的配置中心API，统一管理各类配置，实现配置的集中化管理与便捷操作，并提供了简单的Web界面。
|
||||
# Config Center (配置中心)
|
||||
|
||||
## **背景与目标**
|
||||
[](https://fastapi.tiangolo.com)
|
||||
[](https://www.python.org/)
|
||||
[](https://www.sqlite.org/)
|
||||
[](LICENSE)
|
||||
|
||||
随着项目不断扩展，各类配置（如环境变量、服务参数、数据库连接等）日益增多且复杂。为实现配置的集中化管理与便捷操作，需开发一款配置中心，使团队成员能够高效地查看、修改、新增和删除配置项，降低因配置分散导致的维护成本和出错风险，提升研发效率与系统稳定性。
|
||||
基于FastAPI开发的现代化配置中心，提供统一的配置管理解决方案。通过直观的Web界面和RESTful API，实现配置的集中化管理与便捷操作。
|
||||
|
||||
## **功能**
|
||||
## ✨ 主要特性
|
||||
|
||||
1. **配置管理**：支持配置的增删改查，包括环境变量、服务参数、数据库连接等。
|
||||
2. **权限控制**：实现用户角色与权限管理，确保配置安全。
|
||||
3. **版本控制**：记录配置的修改历史，便于回滚。
|
||||
4. **Web界面**：提供简洁易用的Web界面，方便用户操作。
|
||||
5. **API接口**：提供RESTful API接口，支持外部系统集成。
|
||||
- 🔄 **配置管理**
|
||||
- 支持多种配置类型（环境变量、服务参数、数据库连接等）
|
||||
- 提供配置的增删改查功能
|
||||
- 实时配置更新，无需重启服务
|
||||
|
||||
## **修改**
|
||||
1. 精简功能，去除用户管理和鉴权；
|
||||
2. 已完成首页的优化工作，主要改进包括：
|
||||
- 优化了统计卡片的设计，添加了渐变背景和精致的阴影效果
|
||||
- 改进了图标和数字的视觉效果，增加了文字阴影和图标动画
|
||||
- 添加了数据趋势指标，以更直观的方式展示数据状态
|
||||
- 优化了快速入门指南的样式，增加了悬停效果和平滑过渡动画
|
||||
- 调整了响应式布局的间距和尺寸，确保在各种设备上都能良好显示
|
||||
- 📊 **版本控制**
|
||||
- 记录配置修改历史
|
||||
- 支持配置版本回滚
|
||||
- 变更追踪与审计
|
||||
|
||||
- 🌐 **Web界面**
|
||||
- 现代化的用户界面设计
|
||||
- 直观的配置操作体验
|
||||
- 支持配置搜索与筛选
|
||||
|
||||
- 🔌 **API集成**
|
||||
- RESTful API接口
|
||||
- 支持多种客户端集成
|
||||
- 详细的API文档
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
- **后端框架**: FastAPI
|
||||
- **数据库**: SQLite
|
||||
- **ORM**: SQLAlchemy
|
||||
- **前端框架**: 原生JavaScript + 模板引擎
|
||||
- **文档**: OpenAPI (Swagger)
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Python 3.7+
|
||||
- pip
|
||||
|
||||
### 安装
|
||||
|
||||
1. 克隆仓库
|
||||
```bash
|
||||
git clone https://github.com/guyue55/config_center.git
|
||||
cd config_center
|
||||
```
|
||||
|
||||
2. 安装依赖
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. 运行服务
|
||||
```bash
|
||||
python run.py
|
||||
```
|
||||
|
||||
访问 http://localhost:8000 即可打开Web界面
|
||||
|
||||
## 📚 API文档
|
||||
|
||||
启动服务后，访问以下地址查看API文档：
|
||||
|
||||
- Swagger UI: http://localhost:8000/docs
|
||||
- ReDoc: http://localhost:8000/redoc
|
||||
|
||||
## 🔧 配置说明
|
||||
|
||||
主要配置文件位于 `app/core/config.py`，包含以下配置项：
|
||||
|
||||
- 服务端口
|
||||
- 数据库连接
|
||||
- 日志配置
|
||||
- 其他系统参数
|
||||
|
||||
## 📦 部署
|
||||
|
||||
### Docker部署
|
||||
|
||||
```bash
|
||||
# 构建镜像
|
||||
docker build -t config-center .
|
||||
|
||||
# 运行容器
|
||||
docker run -d -p 8000:8000 config-center
|
||||
```
|
||||
|
||||
### 传统部署
|
||||
|
||||
1. 安装Python环境
|
||||
2. 安装项目依赖
|
||||
3. 配置系统环境变量
|
||||
4. 使用gunicorn或uvicorn启动服务
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
欢迎提交Issue和Pull Request！
|
||||
|
||||
## 📄 开源协议
|
||||
|
||||
本项目采用 [MIT](LICENSE) 协议。
|
||||
Loading…
Reference in New Issue
Block a user