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)

kanban-board
Searching Database…

What is this?Focalboard is an open source, multilingual, self-hosted project management tool — an alternative to Trello, Notion, and Asana — for defining, organizing, tracking and managing work across individuals and teams.
Is it a desktop app, a server, or both?Both. Personal Desktop is a single-user app for macOS, Windows and Linux for your own todos and projects; Personal Server is a multi-user server you host yourself, meant for development and personal use.
Is the project still being actively worked on?No — a warning at the top of the README says the repository is currently not maintained and its authors are looking for new maintainers, so expect no active fixes or updates.
Do my boards stay on my machine, or does some cloud service see them?They stay with you: the standalone apps package the server to run locally against SQLite, and the Personal Server is hosted by you — there is no vendor cloud in the picture.
Is this the same thing as the Mattermost Boards plugin?No. This repo contains only standalone Focalboard; the Mattermost plugin edition lives in a separate repository, mattermost/mattermost-plugin-boards.
Does Focalboard have an API I can build against?Yes — Boards API documentation is available, so you can integrate with or script against your self-hosted server.
Can I run the server on ARM, like a Raspberry Pi?Only experimentally: you can build a linux/arm64 image with docker build --platform linux/arm64, but cross-compilation isn't fully supported, so build on the target platform itself.
Why choose Focalboard over Trello or Notion?It is open source and self-hosted, so your board data stays on your own machine or server instead of a vendor's cloud — and the app is multilingual.
Size
57.8 MB
Stars
26.5K
Age
6y
Commits · 90 Days