yi
ffc7eef984
- 生成完整的 README.md 项目文档 - 统一图片路径为相对引用 - 完善 .gitignore 配置，添加常见忽略项 - 清理未使用的临时文件和图片资源 - 删除废弃的脚本文件
88 lines
3.7 KiB
Markdown
88 lines
3.7 KiB
Markdown
# 云海财务系统
|
||
|
||
## 1. 项目简介
|
||
|
||
- **项目概述**：云海财务系统是一款高效、智能、专业的企业财务与项目管理平台，能够全方位提升企业的项目监控与资金流转效率。
|
||
- **项目定位**：主要面向中大型企业、工程建设及跨国分公司，提供财务报销、项目预算与进度管理服务。
|
||
- **核心价值**：实现项目与财务数据的无缝对接，简化审批流，实时监控预算使用情况，确保企业资金健康与合规。
|
||
|
||
## 2. 整体架构与技术栈
|
||
|
||
本系统采用前后端分离的现代化架构，通过 Docker 容器化部署以确保高可用性。
|
||
|
||
### 技术栈展示：
|
||
- **后端技术**：Node.js + Express
|
||
- **前端技术**：React 18 + TypeScript + Ant Design 5 + Vite
|
||
- **数据库**：PostgreSQL 15
|
||
- **部署技术**：Docker / Docker Compose
|
||
|
||
### 系统架构图
|
||
*(暂无架构图，系统分为前端应用容器、后端 API 容器及独立的 PostgreSQL 数据库容器)*
|
||
|
||
## 3. 项目目录概览
|
||
|
||
```text
|
||
├── backend/ # 后端服务源码
|
||
│ ├── routes/ # API路由
|
||
│ ├── services/ # 业务逻辑
|
||
│ ├── migrations/ # 数据库迁移脚本
|
||
│ └── app.js # 后端主程序
|
||
├── frontend/ # 前端服务源码
|
||
│ ├── src/ # React源码及组件
|
||
│ └── vite.config.ts # Vite配置
|
||
├── scripts/ # 初始化脚本 (如 init_sample_data.sql)
|
||
└── docker-compose.full.yml # Docker本地部署配置
|
||
```
|
||
|
||
## 4. 核心业务功能
|
||
|
||
- **项目管理**：支持项目的创建、进度跟踪、合同与里程碑管理。
|
||
- **财务管理**：包括财务报销、预支款申请、付款申请与核销流程。
|
||
- **采购与供应链**：商品管理、采购申请、订单管理与入库记录。
|
||
- **伙伴管理**：集中管理供应商、分包商与客户信息。
|
||
- **数据分析与仪表盘**：直观展示核心财务数据及项目状态。
|
||
|
||
## 5. 实际应用场景示例
|
||
|
||
- **跨国分公司财务管控**：海外分公司提交预支与报销申请，总部可在线审核，统一汇率转换及预算扣减。
|
||
- **工程类项目核算**：将施工日志与项目付款节点绑定，确保按进度结算分包商款项。
|
||
- **企业日常运营**：员工出差报销、办公采购，全流程数字化审批与记录。
|
||
|
||
## 6. 帮助解决的核心问题
|
||
|
||
- **财务数据孤岛**：项目信息与财务开销割裂，难以追踪真实成本。
|
||
- **审批效率低下**：传统纸质或邮件审批慢、易遗漏。
|
||
- **预算超支风险**：缺乏实时的数据监控及超支预警机制。
|
||
|
||
## 7. 快速开始
|
||
|
||
### 环境要求
|
||
- Docker 及 Docker Compose
|
||
- Node.js (如需本地独立运行)
|
||
|
||
### 安装与运行步骤 (基于 Docker)
|
||
|
||
本系统内置了 `docker-compose.full.yml` 文件及示例数据初始化脚本，可一键启动全套服务。
|
||
|
||
1. **一键构建与启动**：
|
||
```bash
|
||
docker-compose -f docker-compose.full.yml up -d --build
|
||
```
|
||
2. **检查服务状态**：
|
||
```bash
|
||
docker-compose -f docker-compose.full.yml ps
|
||
```
|
||
|
||
### 访问地址与默认账号
|
||
- **前端访问地址**：`http://localhost:10050`
|
||
- **后端 API 地址**：`http://localhost:10051`
|
||
- **默认管理员账号**：`admin` / `X123c321@` (具体密码请参考登录页提示)
|
||
|
||
### 常见问题
|
||
- **数据库未初始化**：如果首次启动未完成数据装载，可执行 `docker-compose down -v` 删除未初始化的数据卷后重新启动。
|
||
- **端口冲突**：如果 `10050` 或 `10051` 端口已被占用，请修改 `docker-compose.full.yml` 中的端口映射。
|
||
|
||
## 8. 运行示例截图
|
||
|
||
*(截图预留位置)*
|