项目介绍:Huly Platform
关于Huly Platform
Huly Platform是一个旨在加速商业应用开发的强大框架,例如客户关系管理系统(CRM)。该平台包含多个应用程序,如聊天、项目管理、CRM、人力资源管理(HRM)和候选人追踪系统(ATS)。多个团队正在基于该平台构建产品,其中包括Huly和TraceX。
自托管
如果用户对自托管Huly感兴趣而不打算进行修改或贡献,建议使用huly-selfhost。这一项目通过docker
提供了一个便捷的托管方法,设计为易于使用并快速设置,可轻松在自己的服务器上使用Huly。
开始之前的准备
安装Huly Platform之前,确保系统满足以下要求:
- Node.js,需要v20.11.0版本。
- Docker和Docker Compose。
安装步骤
需要安装Microsoft的rush来安装应用程序:
- 通过以下命令全局安装Rush:
npm install -g @microsoft/rush
- 导航到项目的根目录并运行以下命令:
或者,你可以简单地执行:rush install rush build
sh ./scripts/presetup-rush.sh
开发环境搭建
开发环境的搭建需要在系统上安装Docker,并支持Linux和macOS上的amd64和arm64容器。
- 进入开发目录并执行如下命令:
cd ./dev/ rush build rush bundle rush package rush validate rush svelte-check rush docker:build rush docker:up
默认条件下,将为MongoDB、Elasticsearch和MinIO创建名为dev_db, dev_elastic和dev_files的Docker卷。在使用之前,需要创建一个工作区和一个账号并将其与工作区关联。
开发模式
开发模式提供更流畅的开发过程,支持实时重新加载。
- 进入开发生产目录并验证并启动服务器:
cd dev/prod rush validate rushx dev-server
然后访问http://localhost:8080,点击右侧面板底部的"以密码登录"链接,使用以下登录凭证:
- 邮箱:user1
- 密码:1234
- 工作区:ws1
项目结构和数据库更新
如果项目结构更新,可能需要重新连接和重建项目:
rush update
rush build
此外,还可能需要升级正在运行的数据库:
cd ./dev/tool
rushx upgrade -f
测试
单元测试
执行所有测试命令:
rush test
在包目录内单独执行测试命令:
rushx test
UI测试
建立并运行UI测试的命令:
cd ./tests
rush build
rush bundle
rush docker:build
./prepare.sh
rushx uitest
或者在开发环境执行UI测试的命令:
cd ./tests
./create-local.sh
cd ./sanity
rushx dev-uitest
包发布
发布包的命令:
node ./common/scripts/bump.js -p projectName
通过这些详细步骤和说明,Huly Platform为开发者提供了一个完整的框架,用于构建各种高效的业务应用程序。希望这项平台能让更多开发者和团队受益,提高其项目的开发效率和质量。