mirror of
https://github.com/MeowLynxSea/CatismImage.git
synced 2025-07-09 10:54:35 +00:00
Update README
This commit is contained in:
parent
05310ab065
commit
256c046962
42
README.md
42
README.md
@ -1,9 +1,11 @@
|
|||||||
# CatismImage 项目
|
# CatismImage 项目
|
||||||
|
|
||||||
## 项目简介
|
## 项目简介
|
||||||
|
|
||||||
CatismImage 是一个基于Web的图片存储和管理系统,提供用户友好的界面来上传、管理和查看图片。
|
CatismImage 是一个基于Web的图片存储和管理系统,提供用户友好的界面来上传、管理和查看图片。
|
||||||
|
|
||||||
## 功能特点
|
## 功能特点
|
||||||
|
|
||||||
- 用户认证和个性化设置
|
- 用户认证和个性化设置
|
||||||
- 图片上传和管理功能
|
- 图片上传和管理功能
|
||||||
- 实时流量和存储空间监控
|
- 实时流量和存储空间监控
|
||||||
@ -12,23 +14,45 @@ CatismImage 是一个基于Web的图片存储和管理系统,提供用户友
|
|||||||
- WebSocket实时数据更新
|
- WebSocket实时数据更新
|
||||||
|
|
||||||
## 安装指南
|
## 安装指南
|
||||||
|
|
||||||
1. 确保已安装Python 3.8+
|
1. 确保已安装Python 3.8+
|
||||||
2. 克隆项目仓库
|
2. 克隆项目仓库
|
||||||
3. 安装Python依赖:
|
3. 安装Python依赖:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
4. 配置数据库连接信息
|
|
||||||
5. 运行后端服务:
|
4. 配置环境变量:
|
||||||
|
|
||||||
|
在.env或系统添加以下必需环境变量:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
# S3存储配置
|
||||||
|
S3_ENDPOINT=your_s3_endpoint
|
||||||
|
S3_ACCESS_KEY=your_access_key
|
||||||
|
S3_SECRET_KEY=your_secret_key
|
||||||
|
S3_BUCKET=your_bucket_name
|
||||||
|
|
||||||
|
# MongoDB配置
|
||||||
|
MONGO_URI=mongodb://your_mongo_uri
|
||||||
|
MONGO_DB=your_database_name
|
||||||
```
|
```
|
||||||
|
|
||||||
|
5. 运行后端服务:
|
||||||
|
|
||||||
|
```bsh
|
||||||
python app.py
|
python app.py
|
||||||
```
|
```
|
||||||
|
|
||||||
6. 访问前端页面:
|
6. 访问前端页面:
|
||||||
```
|
|
||||||
|
```bash
|
||||||
http://localhost:5000
|
http://localhost:5000
|
||||||
```
|
```
|
||||||
|
|
||||||
## 使用说明
|
## 使用说明
|
||||||
|
|
||||||
1. 注册/登录后获取用户Key
|
1. 注册/登录后获取用户Key
|
||||||
2. 使用上传功能添加图片
|
2. 使用上传功能添加图片
|
||||||
3. 在仪表板查看存储使用情况和流量统计
|
3. 在仪表板查看存储使用情况和流量统计
|
||||||
@ -36,10 +60,16 @@ CatismImage 是一个基于Web的图片存储和管理系统,提供用户友
|
|||||||
5. 在设置中自定义主题颜色和模式
|
5. 在设置中自定义主题颜色和模式
|
||||||
|
|
||||||
## 技术栈
|
## 技术栈
|
||||||
|
|
||||||
- 前端:HTML5, CSS3, JavaScript, Bootstrap
|
- 前端:HTML5, CSS3, JavaScript, Bootstrap
|
||||||
- 后端:Python Flask
|
- 后端:Python Flask
|
||||||
- 数据库:SQLite/MySQL
|
- 数据库:MongoDB
|
||||||
- 实时通信:WebSocket
|
- 实时通信:WebSocket
|
||||||
|
|
||||||
|
## TODO List
|
||||||
|
|
||||||
|
完善爱发电支付部分
|
||||||
|
|
||||||
## 贡献指南
|
## 贡献指南
|
||||||
欢迎提交Pull Request或报告Issue。请确保代码风格一致并通过所有测试。
|
|
||||||
|
欢迎提交Pull Request或报告Issue。请确保代码风格一致并通过所有测试
|
Loading…
Reference in New Issue
Block a user