# oa

**Repository Path**: zcoolq/oa

## Basic Information

- **Project Name**: oa
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-02
- **Last Updated**: 2025-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OA办公系统

基于Vue 3 + Spring Boot的企业级办公自动化系统

## 📋 项目概述

OA办公系统是一个完整的企业级办公自动化解决方案，采用前后端分离架构设计，实现了用户管理、组织架构、工作流程、公告通知、考勤管理、文档管理等核心功能模块。

### 技术架构

**前端技术栈**
- Vue 3.4 + Element Plus + Vite
- Pinia状态管理 + Vue Router路由
- Axios + JavaScript ES6+

**后端技术栈**  
- Spring Boot 3.2 + Spring Security
- MyBatis Plus + MySQL 8.0 + Redis
- JWT认证 + Swagger API文档

**部署方案**
- Docker + Docker Compose容器化部署
- Nginx反向代理

## 🚀 快速开始

### 前置要求

请确保您的开发环境满足以下要求：

#### 传统部署
- Node.js 18+ 
- Java 17+
- Maven 3.8+
- MySQL 8.0+
- Redis 6.0+

#### Docker部署（推荐）
- Docker 20.10+
- Docker Compose 2.0+

### 安装指南

详细的环境安装指南请参考：[INSTALLATION-GUIDE.md](INSTALLATION-GUIDE.md)

### 一键部署（Docker）

1. **克隆项目**
   ```bash
   git clone <repository-url>
   cd oa
   ```

2. **配置环境变量**
   ```bash
   cp .env.example .env
   # 根据实际情况修改 .env 文件中的配置
   ```

3. **启动服务**
   ```bash
   # Linux/macOS
   chmod +x docker-start.sh
   ./docker-start.sh start
   
   # Windows
   docker-start.bat start
   ```

4. **访问系统**
   - 前端地址：http://localhost
   - 后端API：http://localhost:8080
   - API文档：http://localhost:8080/swagger-ui.html

5. **默认账号**
   - 用户名：admin
   - 密码：admin123

### 传统部署

#### 后端启动
```bash
cd oa-backend
mvn clean install
mvn spring-boot:run
```

#### 前端启动
```bash
cd oa-web
npm install
npm run dev
```

## 📁 项目结构

```
oa/
├── oa-web/                     # 前端项目
│   ├── src/
│   │   ├── api/               # API接口
│   │   ├── components/        # 组件
│   │   ├── router/            # 路由
│   │   ├── stores/            # 状态管理
│   │   ├── styles/            # 样式
│   │   ├── utils/             # 工具
│   │   └── views/             # 页面
│   ├── Dockerfile
│   └── package.json
├── oa-backend/                 # 后端项目
│   ├── src/main/java/com/oa/
│   │   ├── config/            # 配置
│   │   ├── controller/        # 控制器
│   │   ├── entity/            # 实体
│   │   ├── mapper/            # 数据访问
│   │   ├── service/           # 业务逻辑
│   │   └── security/          # 安全配置
│   ├── sql/                   # 数据库脚本
│   ├── Dockerfile
│   └── pom.xml
├── docker/                     # Docker配置
├── docker-compose.yml          # 容器编排
└── README.md
```

## 🎯 核心功能

### 系统管理
- 👥 **用户管理**：用户CRUD、状态管理、权限分配
- 🏢 **组织架构**：部门管理、职位管理、树形结构
- 🔐 **权限管理**：角色管理、权限分配、RBAC模型
- ⚙️ **系统配置**：参数设置、数据字典、系统监控

### 办公功能
- 📢 **公告通知**：公告发布、通知推送、分类管理
- 🕒 **考勤管理**：考勤打卡、请假申请、统计报表
- 📁 **文档管理**：文件上传、分类管理、权限控制
- 🔄 **工作流程**：流程定义、任务分配、审批管理

### 其他特性
- 📊 **仪表盘**：数据统计、快捷操作、个人信息
- 🔍 **搜索功能**：全局搜索、高级筛选
- 📱 **响应式设计**：支持PC、平板、手机
- 🔒 **安全防护**：JWT认证、CORS、CSRF防护

## 🛠️ 开发指南

### API接口文档
系统启动后访问：http://localhost:8080/swagger-ui.html

### 数据库设计
详细的数据库表结构请查看：`oa-backend/sql/`目录

### 权限模型
采用RBAC（基于角色的访问控制）模型：
- 用户（User）→ 角色（Role）→ 权限（Permission）
- 支持数据权限和功能权限

### 开发规范
- 前端：Vue 3 Composition API + `<script setup>`语法
- 后端：RESTful API设计 + 统一响应格式
- 数据库：驼峰命名 + 逻辑删除

## 🔧 配置说明

### 环境变量
主要配置项说明：

| 变量名 | 说明 | 默认值 |
|--------|------|--------|
| MYSQL_ROOT_PASSWORD | MySQL root密码 | root123456 |
| MYSQL_DATABASE | 数据库名 | oa_system |
| MYSQL_USER | 数据库用户 | oa_user |
| MYSQL_PASSWORD | 数据库密码 | oa123456 |
| REDIS_PASSWORD | Redis密码 | redis123456 |
| JWT_SECRET | JWT密钥 | 自动生成 |

### 端口配置
- 前端：80（生产）/ 5173（开发）
- 后端：8080
- MySQL：3306
- Redis：6379

## 📚 文档说明

- [INSTALLATION-GUIDE.md](INSTALLATION-GUIDE.md) - 环境安装指南
- [README-Docker.md](README-Docker.md) - Docker部署指南
- [PROJECT-SUMMARY.md](PROJECT-SUMMARY.md) - 项目完成总结

## 🐛 故障排除

### 常见问题

1. **前端启动失败**
   - 检查Node.js版本是否为18+
   - 尝试删除node_modules重新安装

2. **后端启动失败**
   - 检查Java版本是否为17+
   - 确认MySQL和Redis服务已启动

3. **Docker部署失败**
   - 检查Docker服务是否运行
   - 确认端口未被占用

4. **数据库连接失败**
   - 检查数据库配置是否正确
   - 确认用户权限设置

### 日志查看
```bash
# 查看所有服务日志
./docker-start.sh logs

# 查看特定服务日志
./docker-start.sh logs backend
./docker-start.sh logs frontend
```

## 🔄 服务管理

```bash
# 启动服务
./docker-start.sh start

# 停止服务
./docker-start.sh stop

# 重启服务
./docker-start.sh restart

# 查看状态
./docker-start.sh status

# 备份数据
./docker-start.sh backup

# 清理数据（危险操作）
./docker-start.sh clean
```

## 🚀 生产部署

### 安全配置
- 修改所有默认密码
- 配置HTTPS证书
- 设置防火墙规则
- 启用访问日志

### 性能优化
- 配置数据库连接池
- 启用Redis集群
- 使用CDN加速静态资源
- 配置负载均衡

### 监控告警
- 配置日志收集
- 设置监控告警
- 定期数据备份
- 性能监控

## 🤝 贡献指南

1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交变更 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request

## 📄 许可证

本项目基于 MIT 许可证开源 - 查看 [LICENSE](LICENSE) 文件了解详情

## 📞 联系我们

如果您有任何问题或建议，请通过以下方式联系我们：

- 项目Issue：提交GitHub Issue
- 技术交流：加入项目讨论群

---

⭐ 如果这个项目对您有帮助，请给我们一个星标！