mattermost/focalboard

Focalboard

[!WARNING] 自2023年9月15日起，Mattermost, Inc. 工作人员不再审查或合并本仓库（mattermost/focalboard）中Focalboard或Mattermost Boards插件的拉取请求。我们鼓励社区分叉此仓库以继续开发和贡献。

这些变更的原因是为了将Mattermost开发资源集中在改进平台性能和核心功能上，确保Mattermost继续保持弹性、稳定，并成为关键业务的最佳选择。

💡 了解更多

!https://github.com/mattermost/focalboard/actions/workflows/ci.yml/badge.svg !https://github.com/mattermost/focalboard/actions/workflows/codeql-analysis.yml/badge.svg !https://github.com/mattermost/focalboard/actions/workflows/dev-release.yml/badge.svg !https://github.com/mattermost/focalboard/actions/workflows/prod-release.yml/badge.svg

!Focalboard

镜像概述和主要用途

Focalboard是一款开源、多语言、自托管的项目管理工具，旨在作为Trello、Notion和Asana的替代方案。它帮助个人和团队定义、组织、跟踪和管理工作，提供灵活的任务管理和协作功能。该工具提供三种部署版本，满足不同场景需求：Mattermost插件版（集成到现有Mattermost实例）、个人桌面版（独立单用户应用）和个人服务器版（多用户开发和个人使用）。

核心功能和特性

• 开源免费：完全开源，支持社区自定义和扩展
• 多语言支持：支持多种语言，适应全球用户需求
• 自托管部署：数据完全自主控制，保障隐私安全
• 多版本选择：
  • Mattermost插件版：与Mattermost消息协作平台深度集成
  • 个人桌面版：支持Windows、macOS和Linux系统的单用户本地应用
  • 个人服务器版：多用户访问的独立服务器部署
• 灵活的项目管理：支持任务定义、组织、跟踪和团队协作
• API支持：提供完整API文档，支持第三方集成和自动化

使用场景和适用范围

• 个人项目管理：通过桌面版或个人服务器版管理个人任务、待办事项和项目进度
• 团队协作：小型团队使用个人服务器版进行项目协作和任务分配
• Mattermost集成：已部署Mattermost的团队可通过插件版将项目管理与即时通讯结合
• 开发环境：开发者可基于开源代码自定义功能或贡献社区

使用方法和配置说明

Docker部署示例

运行官方镜像

bash
docker run -it -p 80:8000 mattermost/focalboard

该命令会启动Focalboard服务器，映射容器的8000端口到主机的80端口，通过http://localhost即可访问。

构建自定义镜像

针对当前架构构建：

bash
docker build -f docker/Dockerfile .

针对自定义架构（实验性）：

bash
docker build -f docker/Dockerfile --platform linux/arm64 .

其他部署方式

Mattermost插件版

1. 从https://github.com/mattermost/focalboard/releases%E4%B8%8B%E8%BD%BD%60mattermost-plugin-focalboard.tar.gz%60%E6%96%87%E4%BB%B6
2. 在Mattermost系统控制台中安装插件
3. 安装完成后，从左上角菜单中选择Boards即可使用

个人桌面版

• Windows：
  • 从Microsoft Store下载，或从https://github.com/mattermost/focalboard/releases%E4%B8%8B%E8%BD%BD%60focalboard-win.zip%60%EF%BC%8C%E8%A7%A3%E5%8E%8B%E5%90%8E%E8%BF%90%E8%A1%8C%60Focalboard.exe%60
• macOS：从Mac App Store下载安装
• Linux：从https://github.com/mattermost/focalboard/releases%E4%B8%8B%E8%BD%BD%60focalboard-linux.tar.gz%60%EF%BC%8C%E8%A7%A3%E5%8E%8B%E5%90%8E%E8%BF%90%E8%A1%8C%60focalboard-app%60

个人服务器版（Ubuntu）

按照官方安装指南下载并运行编译好的Focalboard个人服务器。

开发环境设置

1. 将https://github.com/mattermost/mattermost-server%E5%85%8B%E9%9A%86%E5%88%B0%E5%90%8C%E7%BA%A7%E7%9B%AE%E5%BD%95
2. 在focalboard目录创建.env文件，内容：

   EXCLUDE_ENTERPRISE="1"
   

3. 构建服务器：

   bash
   make prebuild
   make
   

4. 运行服务器：

   bash
   ./bin/focalboard-server
   

5. 在浏览器访问http://localhost:8000（端口在config.json中配置）

单元测试

提交代码前运行make ci，包含以下测试步骤：

• 服务器单元测试：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获取最新更新
• 问题反馈：https://github.com/mattermost/focalboard/issues/new?assignees=&labels=bug&template=bug_report.md&title=
• 社区交流：加入~Focalboard社区频道

API文档

可通过以下链接访问Boards API文档：https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html