用户登录功能
This commit is contained in:
82
README.md
82
README.md
@@ -4,12 +4,14 @@
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 🔐 **用户认证**: 密码登录保护,确保数据安全
|
||||
- ✅ **任务管理**: 添加、编辑、删除工作任务
|
||||
- ⏱️ **时间追踪**: 点击开始/停止计时,自动记录任务时长
|
||||
- 📊 **时间统计**: 查看每日、每周的工作时间统计
|
||||
- 🤖 **AI润色**: 使用AI优化任务描述,让工作记录更专业
|
||||
- 📱 **响应式设计**: 支持桌面和移动设备
|
||||
- 💾 **本地存储**: 数据存储在本地SQLite数据库中
|
||||
- 🐳 **Docker支持**: 一键部署,开箱即用
|
||||
|
||||
## 技术栈
|
||||
|
||||
@@ -20,12 +22,40 @@
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 1. 环境要求
|
||||
### 方法一: 使用Docker (推荐)
|
||||
|
||||
```bash
|
||||
# 1. 克隆项目
|
||||
git clone <repository-url>
|
||||
cd worklist
|
||||
|
||||
# 2. (可选) 配置环境变量
|
||||
cp .env.example .env
|
||||
# 编辑 .env 文件,设置自定义用户名和密码
|
||||
|
||||
# 3. 启动Docker容器
|
||||
docker-compose up -d
|
||||
|
||||
# 4. 访问应用
|
||||
# 打开浏览器访问 http://localhost:5000
|
||||
# 默认用户名: admin
|
||||
# 默认密码: admin123
|
||||
```
|
||||
|
||||
**首次启动说明:**
|
||||
- Docker会自动创建数据库和默认用户
|
||||
- 默认用户名: `admin`, 默认密码: `admin123`
|
||||
- 可通过环境变量 `DEFAULT_USERNAME` 和 `DEFAULT_PASSWORD` 自定义
|
||||
- 登录后请立即修改密码
|
||||
|
||||
### 方法二: 本地运行
|
||||
|
||||
#### 1. 环境要求
|
||||
|
||||
- Python 3.7 或更高版本
|
||||
- 现代浏览器 (Chrome, Firefox, Safari, Edge)
|
||||
|
||||
### 2. 安装和运行
|
||||
#### 2. 安装和运行
|
||||
|
||||
#### 方法一:使用启动脚本(推荐)
|
||||
|
||||
@@ -44,30 +74,64 @@ python start.py
|
||||
- 启动服务器
|
||||
- 自动打开浏览器
|
||||
|
||||
**首次使用需创建用户:**
|
||||
```bash
|
||||
# 运行用户创建脚本
|
||||
python create_user.py
|
||||
```
|
||||
|
||||
#### 方法二:手动启动
|
||||
|
||||
```bash
|
||||
# 1. 安装Python依赖
|
||||
pip install -r backend/requirements.txt
|
||||
|
||||
# 2. 启动服务器
|
||||
# 2. 创建初始用户
|
||||
python create_user.py
|
||||
|
||||
# 3. 启动服务器
|
||||
cd backend
|
||||
python app.py
|
||||
|
||||
# 3. 在浏览器中访问
|
||||
# 4. 在浏览器中访问
|
||||
# http://localhost:5000
|
||||
```
|
||||
|
||||
### 3. 配置AI润色功能(可选)
|
||||
### 3. 配置说明
|
||||
|
||||
如需使用AI润色功能,请:
|
||||
#### 环境变量配置
|
||||
|
||||
1. 获取OpenAI API密钥
|
||||
2. 编辑 `backend/.env` 文件
|
||||
3. 设置 `OPENAI_API_KEY=your_api_key_here`
|
||||
#### 环境变量配置
|
||||
|
||||
创建 `.env` 文件 (可复制 `.env.example`):
|
||||
|
||||
```bash
|
||||
# Flask配置
|
||||
SECRET_KEY=your-secret-key-here-please-change-this
|
||||
|
||||
# OpenAI API配置(可选,用于AI润色功能)
|
||||
OPENAI_API_KEY=your_openai_api_key
|
||||
|
||||
# Docker首次启动时的默认用户(仅Docker部署时有效)
|
||||
DEFAULT_USERNAME=admin
|
||||
DEFAULT_PASSWORD=admin123
|
||||
```
|
||||
|
||||
**安全建议:**
|
||||
- 生产环境务必修改 `SECRET_KEY`
|
||||
- 修改默认用户名和密码
|
||||
- 登录后立即在系统中修改密码
|
||||
|
||||
#### AI润色功能(可选)
|
||||
|
||||
## 使用指南
|
||||
|
||||
### 登录系统
|
||||
|
||||
1. 首次访问会显示登录页面
|
||||
2. 输入用户名和密码
|
||||
3. 登录成功后进入主界面
|
||||
|
||||
### 基本操作
|
||||
|
||||
1. **添加任务**
|
||||
|
||||
Reference in New Issue
Block a user