Dorisoy.Pan 文档管理系统技术手册

---

安装指南

系统要求

• .NET SDK: 7.0 及以上版本
• Visual Studio 2019 或更高版本
• 数据库: SQL Server 2012 或 MySQL 8.0 及以上
• 开发环境: Windows, Linux, or macOS

安装步骤

服务器端部署

1. 获取代码: 从 GitHub 克隆或下载 Dorisoy.Pan 项目。
2. 安装 .NET SDK: 确保你的系统已安装 .NET 7.0+。
3. Visual Studio: 使用 Visual Studio 2019 打开解决方案文件 Dorisoy.Pan.sln。
4. 恢复 NuGet 包: 在解决方案资源管理器上右键点击并选择“还原NuGet包”。
5. 配置数据库连接: 在 Dorisoy.Pan.API 项目中的 appsettings.json 更新数据库连接字符串。
6. 数据库迁移: 进入 NuGet 包管理器控制台，选择 Dorisoy.Pan.Domain 作为默认项目，并运行 Update-Database 命令。
7. 设置启动项: 将 Dorisoy.Pan.API 设置为启动项目。
8. 启动应用: 按 F5 开始调试，或通过 IIS Express 直接部署。

前端部署

1. Node.js: 确认已安装 Node.js 4.0+ 以及 npm 3+。
2. Angular CLI: 全局安装 Angular CLI (npm install -g @angular/cli)。
3. 初始化前端: 在 \UI 目录下，打开终端运行 npm install 来安装依赖。
4. 运行前端: 继续在终端输入 npm run start，前端将在 localhost:4200 自动开启。

---

项目使用说明

Dorisoy.Pan 提供了一套完整的前后端分离的文档管理系统，支持跨平台运行。后台采用 ASP.NET Core 编写RESTful API，前端则利用Angular框架构建交互界面。

后端操作

• 通过 Swagger UI 访问 /swagger 接口文档来了解详细的 API 调用方法。
• 使用 JWT 为API请求提供认证保护。

前端体验

• 登陆界面使用提供的 demo 账号进行测试 ([e-mail], 密码:admin@123)。
• 功能涉及文件上传、下载、分类管理等，全部通过前端发送请求至后端API完成。

---

项目API使用文档

由于具体的API细节未在问题中详细列出，通常情况下，开发者应当查看项目的 Swagger 文档，位于 /swagger 路径下，以获取每个端点的详细信息，包括HTTP方法、路径参数、请求体格式以及响应数据结构。

示例 API 结构（非实际接口）

• 文件上传:
  • URL: /api/files/upload
  • Method: POST
  • Parameters: 二进制文件流
• 文件列表:
  • URL: /api/files/list
  • Method: GET
  • Query Parameters: 分页参数, 搜索关键字等

---

项目安装方式

前面的安装指南部分已经详尽描述了从获取源码到成功部署运行的完整过程，包括服务器端和客户端的所有准备和启动步骤。

---

总结

Dorisoy.Pan 作为一个高效率、安全的文档管理系统，其设计思想融合了现代软件架构的最佳实践。通过仔细遵循上述指南，您可以轻松地设置好该系统，无论是开发还是部署阶段。记住，对于更深入的开发工作，深入阅读项目中的源码注释和相关文档将会非常有益。