无忧·企业文档系统技术文档

无忧·企业文档系统技术文档

jvs-knowledge-ui 【企业级在线文档】，解决企业内部文档编辑、知识沉淀、知识协同等痛点。项目主要采用Java开发，基础框架采用JVS（spring cloud+Vue）。适用场景：适用于个人、团队、企业使用，提供云笔记、个人知识沉淀、在线产品手册、团队内部知识库、在线电子教程、全文内容搜索、CMS内容展示等功能。支持私有化部署场景。 项目地址: https://gitcode.com/gh_mirrors/jv/jvs-knowledge-ui

安装指南

环境准备

确保您的开发与部署环境满足以下条件：

• 开发环境:
  • JDK 1.8 或更高版本
  • Maven 3.6+ 或 Gradle
  • Node.js 14.16.1 或更高版本（用于前端构建）
  • IDE推荐安装Lombok插件以简化编码
• 运维环境:
  • Docker 和 Docker Compose （建议版本为最新稳定版）
  • Kubernetes (K8S, 可选，用于集群部署)
  • Mysql 或 MariaDB
  • Elasticsearch 用于全文搜索
  • Redis 作为缓存服务
  • Nacos 服务注册与配置中心
  • RabbitMQ 作为消息队列

步骤简述

1. 下载源代码: 分别从提供的GitHub链接下载jvs-knowledge-ui, jvs-apply-document, jvs-ui, 和 jvs项目。

2. 环境搭建: 配置好上述所有依赖服务，例如安装并启动MySQL, Elasticsearch, Redis, Nacos, RabbitMQ。

3. 数据库初始化: 迁移SQL脚本到数据库，一般位于后端项目中的src/main/resources下的SQL脚本。

4. 构建前后端:

   • 前端项目使用Node.js进行编译，执行 npm install 或 yarn，随后 npm run build 或等效命令。
   • 后端项目通过Maven或Gradle编译，使用 mvn clean package 或等效命令构建。

5. 快速部署:

   • 参考jvs-docker-compose仓库中的readme.md文件，使用Docker Compose一键部署，简化部署步骤。

项目使用说明

1. 前端访问:

   • 用户界面通过HTTP访问已部署的服务地址（如 http://localhost:port），具体端口取决于部署配置。
   • 管理员界面会有不同的URL入口，通常需要凭测试账号(testadmin/123456)或其他特定账号登录。

2. 创建文档与知识库:

   • 登录后，用户可以创建新的文档，选择不同类型的编辑器，比如富文本、在线表格等。
   • 创建知识库，定义文集的目录结构，分配协作权限给团队成员。

3. 团队协作:

   • 文档支持多用户实时协同编辑，保证团队合作流畅。
   • 实现文档评论、收藏、分享功能，并可以通过设定密码增加安全性。

项目API使用文档

API文档通常包含于后端服务的文档注释中，使用 Swagger 或类似的 API 文档生成工具自动生成。开发者可在启动后端服务时，在指定端点（如 /swagger-ui.html）查看详细的API接口说明、请求参数、响应示例等。

项目安装方式

• 本地开发部署: 为每个微服务单独构建并运行，确保所有依赖服务（数据库、中间件）已启动。

• 私有化部署:

  • 利用Docker和Docker Compose，通过修改jvs-docker-compose项目中的配置来适应生产环境。
  • 在Kubernetes环境中，可通过部署yaml文件实现服务的自动部署与管理。

请参考快速部署文档（jvs-docker-compose 的 readme.md）获取详尽的部署步骤和最佳实践。对于具体的技术细节和深入理解，查阅各个模块的官方文档以及项目内的README文件将是必要的。

jvs-knowledge-ui 【企业级在线文档】，解决企业内部文档编辑、知识沉淀、知识协同等痛点。项目主要采用Java开发，基础框架采用JVS（spring cloud+Vue）。适用场景：适用于个人、团队、企业使用，提供云笔记、个人知识沉淀、在线产品手册、团队内部知识库、在线电子教程、全文内容搜索、CMS内容展示等功能。支持私有化部署场景。 项目地址: https://gitcode.com/gh_mirrors/jv/jvs-knowledge-ui