编辑 | blame | 历史 | 原始文档

特别说明:源码、JDK、数据库、Redis等安装或存放路径禁止包含中文、空格、特殊字符等

一 环境要求

1.1 开发环境

  • 操作系统:Windows 10/11,MacOS;
  • Node 20.15.0 及以上版本(某些情况下可能需要安装 Python3 环境);
  • pnpm v9.12.0及以上版本;
  • Visual Studio Code (简称 VSCode)

1.2 运行环境

Nginx 建议使用 1.18.0 及以上版本、兼容 OpenResty 或 TongHttpServer 6.0(国产信创)

二 浏览器支持

支持现代浏览器,不支持 IE

IE Edge Firefox Chrome Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

三 关联项目

需要使用下表中的对应分支

项目 分支 说明
jnpf-web-apps-main v6.1.x-stable 前端主项目源码,实际交付范围、内容及相关约束以双方签订的合同约定为准
jnpf-web-apps-main-npm v6.1.x-stable 前端主项目源码(集成流程设计器、Univer报表设计器npm包),实际交付范围、内容及相关约束以双方签订的合同约定为准
jnpf-bpmn v1.1.x-stable 前端流程设计器源代码
jnpf-univer v1.0.x-stable 前端Univer报表设计器源代码

四 使用说明

此项目为前端核心项目,需要与关联项目配套使用,需按如下步骤操作,否则项目无法运行

4.1拉取项目

分别拉取如下项目源码(注意对应版本号):
- jnpf-bpmn:前端流程设计器源代码(非专业版)
- jnpf-univer:前端Univer报表设计器源代码(非专业版)
- jnpf-web-monorepo-framework:前端核心项目源码(非专业版)
- jnpf-web-apps-main:前端主项目源码(非专业版)
- jnpf-web-apps-main-npm:前端主项目源码(集成流程设计器、Univer报表设计器npm包)

4.2 复制项目

4.2.1 专业版用户

含License授权用户

  • 将 jnpf-web-apps-main-npm 项目重命名为 jnpf-web-apps-main 后复制至 jnpf-web-monorepo-framework 项目的 apps/ 目录下

最终核心结构如下:

注意:下述结构中,涉及的文件夹目录不可修改

├── jnpf-web-monorepo-framework 
│   ├── apps
│   ├──   ├── jnpf-web-apps-main  注意:此处文件夹名称不可修改

4.2.2 非专业版用户

  • 将 jnpf-bpmn 项目复制至 jnpf-web-monorepo-framework 项目的 packages/jnpf/plugins/ 目录下
  • 将 jnpf-univer 项目复制至 jnpf-web-monorepo-framework 项目的 packages/jnpf/plugins/ 目录下
  • 将 jnpf-web-apps-main 项目复制至 jnpf-web-monorepo-framework 项目的 apps/ 目录下

最终核心结构如下:

注意:下述结构中,涉及的文件夹目录不可修改

├── jnpf-web-monorepo-framework 
│   ├── apps
│   ├──   ├── jnpf-web-apps-main  注意:此处文件夹名称不可修改
│   ├── packages
│   ├──   ├── jnpf
│   ├──   ├──   ├── plugins
│   ├──   ├──   ├──   ├── jnpf-bpmn 注意:此处文件夹名称不可修改
│   ├──   ├──   ├──   ├── jnpf-univer 注意:此处文件夹名称不可修改

五 其他

其他请参考关联项目根目录下的 READE.md 文件说明

README 4 KB
apps/README 74 b
apps/jnpf-web-apps-main/README 5 KB
apps/jnpf-web-apps-main/src/locales/README 183 b
apps/jnpf-web-apps-main/src/views/x/audit/events/README 1,008 b
apps/jnpf-web-apps-main/src/views/x/audit/signatures/README 741 b
apps/jnpf-web-apps-main/src/views/x/dms/folder-audit/README 796 b
internal/vite-config/src/plugins/inject-app-loading/README 116 b
packages/@core/README 188 b
packages/@core/base/README 59 b
packages/@core/composables/src/use-simple-locale/README 41 b
packages/@core/ui-kit/README 70 b
packages/@core/ui-kit/menu-ui/README 15 b
packages/constants/README 365 b
packages/effects/README 772 b
packages/effects/hooks/README 339 b
packages/effects/layouts/src/basic/README 337 b
packages/effects/plugins/README 742 b
packages/icons/README 339 b
packages/jnpf/hooks/README 303 b
packages/jnpf/plugins/README 68 b
packages/jnpf/plugins/jnpf-bpmn/README 135 b
packages/jnpf/plugins/jnpf-univer/README 60 b
packages/jnpf/utils/README 347 b
packages/onlyoffice-plugins/dev-gateway/README 3 KB
packages/onlyoffice-plugins/dms-qianpiye-annotator/README 1 KB
packages/onlyoffice-plugins/eln-record-filler/README 7 KB
packages/onlyoffice-plugins/eln-template-annotator/README 7 KB
packages/onlyoffice-plugins/shared/README 296 b
packages/styles/README 341 b
packages/types/README 387 b
packages/utils/README 359 b
scripts/turbo-run/README 1 KB
scripts/vsh/README 859 b