Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
[!WARNING] Effective September 15th, 2023, Mattermost, Inc. staff are no longer reviewing or merging pull requests for either Focalboard or the Mattermost Boards plugin in this repository (
mattermost/focalboard
). We encourage the community to fork this repository for continued development and contributions.The reason behind these changes is to focus Mattermost developer resources on improving the platform’s performance and core features to ensure Mattermost continues being resilient, stable, and best-in-breed for critical operations.
️💡 Learn more
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 three editions:
Focalboard plugin: The Focalboard plugin integrates into an exsting Mattermost instance to combine project management tools with messaging and collaboration for teams of all sizes.
Personal Desktop: A standalone, single-user macOS, Windows, or Linux desktop app for your own todos and personal projects.
Personal Server: A standalone, multi-user server for development and personal use.
After downloading and installing the plugin in the System Console, select the menu in the top left corner and select Boards. Access the latest releases of the focalboard plugin by downloading the mattermost-plugin-focalboard.tar.gz
file from the releases in this repository: https://github.com/mattermost/focalboard/releases
focalboard-win.zip
from the latest release, unpack, and run Focalboard.exe
.focalboard-linux.tar.gz
from the latest release, unpack, and open focalboard-app
.Ubuntu: You can download and run the compiled Focalboard Personal Server on Ubuntu by following our latest install guide.
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
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.
Clone mattermost-server into sibling directory.
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.
You can build standalone apps that package the server to run locally against SQLite:
git-bash
prompt.make prebuild
make win-wpf-app
cd win-wpf/msix && focalboard.exe
make prebuild
make mac-app
open mac/dist/Focalboard.app
webgtk
dependencies
sudo apt-get install libgtk-3-dev
sudo apt-get install libwebkit2gtk-4.0-dev
make prebuild
make linux-app
linux/dist/focalboard-linux.tar.gz
to a directory of your choicefocalboard-app
from the directory you have chosendocker run -it -p 80:8000 mattermost/focalboard
docker build -f docker/Dockerfile .
docker build -f docker/Dockerfile --platform linux/arm64 .
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.
Before checking in commits, run make ci
, which is similar to the .gitlab-ci.yml
workflow and includes:
make server-test
cd webapp; npm run check
cd webapp; npm run test
cd webapp; npm run cypress:ci