xiaoshu

小数

大模型 AI 能力平台，为你的下一个创意助力

环境参考

• Node.js 20.13.1
• npm 10.5.2

机器上的相关软件版本不必和此处描述完全一致。由于项目使用vite启动，vite对于Node.js版本有特定要求，需使用18+ or 20 +。

项目设置

git 仓库地址：http://gitlab.smartai.com/qi/xiaoshu

# 安装项目依赖
$ npm install
$ npm install --legacy-peer-deps

# 本地启动项目
$ npm run dev # localhost:80

# 构建项目
$ npm run build

构建项目

$ npm run build

部署到测试环境

该项目的部署已经与自动化部署集成，只是由于gitlab所在服务器环境影响，此项目的部署为半自动部署，核心流程如下：

1. 本地开发机器上进行构建: npm run build
2. gitlab服务器进行dist文件发布

注意：dist目录需要被git进行追踪。

操作流程

# 本地构建
$ npm run build
# 本地构建中...
# .......
# 构建结束 本地开发机器上已存在构建后（更新后）的 dist 目录

# 将本地更改提交到git仓库
$ git add
$ git commit -m 'build: 测试环境部署'
$ git push

项目须知

1. dist目录需要在git进行追踪，不必添加到.gitignore文件中。
2. 每次在本地执行npm run build后，应该将src/assets目录复制到dist目录下，最终dist目录下存在dist/src/assest/目录以及目录下的所有文件。
3. 安装项目依赖使用npm install --legacy-peer-deps，仅使用npm install命令可能无法启动项目。
4. 安装新依赖包需要使用--legacy-peer-deps参数，例如：npm install --save --legacy-peer-deps md5
5. 配置文件src/ajax/url-external-config.js中的REFFERENCE_ASSETS_FILE_URL需要配置，当前值为http://192.168.20.119:11080。如果不配置，则会引起文档引用效果出错，图片和 PDF 文档将无法显示。
6. 项目启动之前，可能需要做一些配置，详情请见下方关于配置文件章节。另外，项目里的几个关键配置文件以及配置项目前都已经提交到git仓库，项目初次启动时，无需特意更改配置文件。仅在开发过程中有需要时，再调整配置文件，新增或移除配置字段。
7. 此项目中的组件库，主要使用 字节跳动出品的企业级设计系统 arco.design
8. 代码编辑器推荐使用vscode

关于配置文件

项目里一共有 2 个配置文件，如下：

• src/ajax/url-external-config.js
• src/utils/config.js

src/ajax/url-external-config.js

此文件中配置了一些外部链接，这些外部链接支撑了项目里的部分功能。例如iframe弹窗，例如 PDF 文档和图片的展示

如果项目里有用到外部链接，请在此文件中进行配置。

src/utils/config.js

此文件配置了项目的一些基本信息，例如项目的名称，项目的介绍，左侧边栏展示的导航项目，图标等。

相关资源

• vuejs
• vue-router
• pinia
• Vite 配置参考.
• 字节跳动前端框架 arco design
• RAGFlow 开源大模型
• mitt