focalboard README

The project's README from github.com/mattermost-community/focalboard. As one markdown file: README.md.

[!WARNING] This repository is currently not maintained. If you're interested in becoming a maintainer please let us know here.

This repository only contains standalone Focalboard. If you're looking for the Mattermost plugin please see mattermost/mattermost-plugin-boards.

Focalboard

CI Status CodeQL Dev Release Prod Release

Focalboard

Focalboard is an open source, multilingual, self-hosted project management tool that's an alternative to Trello, Notion, and Asana.

It helps define, organize, track and manage work across individuals and teams. Focalboard comes in two editions:

Try Focalboard

Personal Desktop (Windows, Mac or Linux Desktop)

Personal Server

Ubuntu: You can download and run the compiled Focalboard Personal Server on Ubuntu by following our latest install guide.

API Docs

Boards API docs can be found over at https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html

Getting started

Our developer guide has detailed instructions on how to set up your development environment for the Personal Server. You can also join the ~Focalboard community channel to connect with other developers.

Create an .env file in the focalboard directory that contains:

EXCLUDE_ENTERPRISE="1"

To build the server:

make prebuild
make

To run the server:

 ./bin/focalboard-server

Then navigate your browser to http://localhost:8000 to access your Focalboard server. The port is configured in config.json.

Once the server is running, you can rebuild just the web app via make webapp in a separate terminal window. Reload your browser to see the changes.

Building and running standalone desktop apps

You can build standalone apps that package the server to run locally against SQLite:

Cross-compilation currently isn't fully supported, so please build on the appropriate platform. Refer to the GitHub Actions workflows (build-mac.yml, build-win.yml, build-ubuntu.yml) for the detailed list of steps on each platform.

Unit testing

Before checking in commits, run make ci, which is similar to the .gitlab-ci.yml workflow and includes:

Staying informed

focalboard (mattermost-community/focalboard)

Searching Database…

这是什么?Focalboard 是一个开源、多语言、可自己搭建的项目管理工具,可以替代 Trello、Notion 和 Asana,用来定义、组织、跟踪和管理个人与团队的各项工作。
它是桌面软件、服务器软件,还是两者都有?两者都有。Personal Desktop 是给 macOS、Windows 和 Linux 用的单用户应用,适合管理自己的待办事项和项目;Personal Server 是你自己搭建的多用户服务器,主要用于开发和个人使用。
这个项目还在积极维护吗?没有——README 顶部的警告说明这个仓库目前不再维护,作者们正在寻找新的维护者,所以别指望有积极的修复或更新。
我的看板数据是留在自己电脑上,还是会被某个云服务看到?数据留在你这里:独立版应用内置了本地服务器,用 SQLite 运行,Personal Server 也是你自己搭建的——整个流程中不涉及任何厂商的云服务。
它和 Mattermost Boards 插件是同一个东西吗?不是。这个仓库只包含独立版的 Focalboard;Mattermost 插件版放在另一个仓库里,叫 mattermost/mattermost-plugin-boards。
Focalboard 有没有我可以用来做二次开发的 API?有——官方提供了 Boards API 文档,你可以在自己搭建的服务器上做集成或写脚本调用。
能把服务器跑在 ARM 设备上吗,比如树莓派?只能算实验性支持:可以用 docker build --platform linux/arm64 构建镜像,但交叉编译没有得到完整支持,所以最好直接在目标设备上构建。
和 Trello 或 Notion 相比,为什么选 Focalboard?它开源而且可以自己搭建,看板数据保存在你自己的电脑或服务器上,而不是厂商的云端——而且应用支持多种语言。
Size
57.8 MB
Stars
26.5K
Age
6y
Commits · 90 Days