[!警告] 自2023年9月15日起,Mattermost, Inc.的员工将不再审核或合并此仓库(
mattermost/focalboard
)中Focalboard或Mattermost Boards插件的拉取请求。我们鼓励社区分叉此仓库以继续开发和贡献。这些变更的原因是为了将Mattermost开发者资源集中在改进平台性能和核心功能上,以确保Mattermost继续保持弹性、稳定性,并在关键操作中保持最佳表现。
💡 了解更多
Focalboard
Focalboard是一个开源、多语言、自托管的项目管理工具,是Trello、Notion和Asana的替代品。
它有助于定义、组织、跟踪和管理个人和团队的工作。Focalboard有三个版本:
-
Focalboard插件:Focalboard插件集成到现有的Mattermost实例中,为各种规模的团队结合项目管理工具与消息传递和协作功能。
-
个人服务器版:一个独立的、多用户服务器,用于开发和个人使用。
尝试Focalboard
Mattermost插件
下载并在系统控制台中安装插件后,选择左上角的菜单并选择Boards。您可以通过从此仓库的发布页面下载mattermost-plugin-focalboard.tar.gz
文件来获取focalboard插件的最新版本:https://github.com/mattermost/focalboard/releases
个人桌面版(Windows、Mac或Linux桌面)
- Windows:从Windows应用商店下载,或从最新发布下载
focalboard-win.zip
,解压后运行Focalboard.exe
。 - Mac:从Mac应用商店下载。
- Linux桌面:从最新发布下载
focalboard-linux.tar.gz
,解压后打开focalboard-app
。
个人服务器版
Ubuntu:您可以通过按照我们最新的安装指南下载并运行编译好的Focalboard个人服务器版。
API文档
Boards API文档可以在https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html找到。
入门指南
我们的开发者指南详细介绍了如何为个人服务器版设置开发环境。您也可以加入~Focalboard社区频道与其他开发者交流。
将mattermost-server克隆到相邻目录。
在focalboard目录中创建一个包含以下内容的.env
文件:
EXCLUDE_ENTERPRISE="1"
构建服务器:
make prebuild
make
运行服务器:
./bin/focalboard-server
然后在浏览器中导航到http://localhost:8000
以访问您的Focalboard服务器。端口在config.json
中配置。
服务器运行后,您可以在单独的终端窗口中通过make webapp
仅重建网页应用。重新加载浏览器以查看更改。
构建和运行独立桌面应用
您可以构建独立应用,将服务器打包以在本地针对SQLite运行:
- Windows:
- 需要Windows 10、Windows 10 SDK 10.0.19041.0和.NET 4.8开发者包
- 打开
git-bash
提示符。 - 运行
make prebuild
- 上述预构建步骤仅在您更改或想安装npm依赖等时需要运行。
- 预构建完成后,您可以重复以下步骤来构建应用并查看更改。
- 运行
make win-wpf-app
- 运行
cd win-wpf/msix && focalboard.exe
- Mac:
- 需要macOS 11.3+和Xcode 13.2.1+
- 运行
make prebuild
- 上述预构建步骤仅在您更改或想安装npm依赖等时需要运行。
- 预构建完成后,您可以重复以下步骤来构建应用并查看更改。
- 运行
make mac-app
- 运行
open mac/dist/Focalboard.app
- Linux:
- 在Ubuntu 18.04上测试
- 安装
webgtk
依赖- 运行
sudo apt-get install libgtk-3-dev
- 运行
sudo apt-get install libwebkit2gtk-4.0-dev
- 运行
- 运行
make prebuild
- 上述预构建步骤仅在您更改或想安装npm依赖等时需要运行。
- 预构建完成后,您可以重复以下步骤来构建应用并查看更改。
- 运行
make linux-app
- 将
linux/dist/focalboard-linux.tar.gz
解压到您选择的目录 - 从您选择的目录运行
focalboard-app
- Docker:
- 要从官方镜像在本地运行:
docker run -it -p 80:8000 mattermost/focalboard
- 为您当前的架构构建:
docker build -f docker/Dockerfile .
- 为自定义架构构建(实验性):
docker build -f docker/Dockerfile --platform linux/arm64 .
- 要从官方镜像在本地运行:
目前不完全支持交叉编译,因此请在适当的平台上构建。有关每个平台上详细步骤的列表,请参考GitHub Actions工作流(build-mac.yml
、build-win.yml
、build-ubuntu.yml
)。
单元测试
提交代码之前,请运行make ci
,这类似于.gitlab-ci.yml
工作流,包括:
- 服务器单元测试:
make server-test
- Web应用ESLint:
cd webapp; npm run check
- Web应用单元测试:
cd webapp; npm run test
- Web应用UI测试:
cd webapp; npm run cypress:ci
保持信息更新
- 变更:查看CHANGELOG了解最新更新
- 错误报告:提交错误报告
- 聊天:加入~Focalboard社区频道