Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Maria A Nunez 568a5f01b6
Merge pull request #5013 from mattermost/update-version-8-0
1 month ago
.github [Refactor]: updated dependency for webapp (#5008) 1 month ago
.vscode Add readme for Mac and Win apps (#2757) 2 years ago
docker [GH-124] Added Docker Arm64 Capability (#1700) 2 years ago
docker-testing Idempotent schema and data migrations (#4253) 2 years ago
docs 📝 docs(README.md): Update project status and contribution guidelines 5 months ago
experiments/webext update webapp dependencies (#3317) 2 years ago
import Update URL to docs page for migrating and reference `.boardarchive` (#4043) 2 years ago
linux [Refactor]: updated dependency for focalboard server (#5009) 1 month ago
mac Update Boards version to 7.3 (#3382) 2 years ago
mattermost-plugin Update to version 8.0 1 month ago
noticegen [feat] Notice.txt generation configuration 2 years ago
server Update to version 8.0 1 month ago
webapp Update to version 8.0 1 month ago
website MM-54013- Removing some mattermost references (#4865) 10 months ago
win-wpf update to version 7.2.0 2 years ago
.dockerignore [GH-124] Added Docker Arm64 Capability (#1700) 2 years ago
.editorconfig Adding initial coding style checking 4 years ago
.gitattributes Git attributes for ignoring website and swagger docs in linguist added. (#3172) 2 years ago
.gitignore Remove product references (#4744) 1 year ago
.gitlab-ci.yml MM-49703: Bump to Go 1.19 (#4489) (#4502) 1 year ago
.gitpod.yml Create .gitpod.yml (#3010) 2 years ago
CHANGELOG.md Update CHANGELOG.md for v0.15 2 years ago
CONTRIBUTING.md 📝 docs(CONTRIBUTING.md): Update contribution guidelines due to change in project maintenance 5 months ago
Dockerfile.build Enable cross-compilation of Linux webapp via Docker (#4528) 1 year ago
LICENSE.txt License product name 4 years ago
Makefile Remove product references (#4744) 1 year ago
NOTICE.txt @mention support (#1147) 3 years ago
README.md 📝 docs(README.md): remove extra heading 5 months ago
SECURITY.md Add SECURITY.md (#2349) 2 years ago
app-config.json Fix indentation 3 years ago
config.json [Refactor]: updated dependency for focalboard server (#5009) 1 month ago
modd-servertest.conf Add sqlite3 tag to modd files and linux app build (#4218) 2 years ago
modd-watchplugin.conf Remove indir directive as it's causing problems in OSX systems (#1328) 3 years ago
modd.conf Add sqlite3 tag to modd files and linux app build (#4218) 2 years ago
pull_request_template.md Update pull_request_template.md (#3487) 2 years ago
responsible_disclosure_policy.md Update responsibile_disclosure_policy.md (#1383) 3 years ago
server-config.json Fix configuration for prometheus address (#2763) 2 years ago

README.md

[!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

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 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.

Try Focalboard

Mattermost Plugin

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

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.

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.

Building and running standalone desktop apps

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

  • Windows:
    • Requires Windows 10, Windows 10 SDK 10.0.19041.0, and .NET 4.8 developer pack
    • Open a git-bash prompt.
    • Run make prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run make win-wpf-app
    • Run cd win-wpf/msix && focalboard.exe
  • Mac:
    • Requires macOS 11.3+ and Xcode 13.2.1+
    • Run make prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run make mac-app
    • Run open mac/dist/Focalboard.app
  • Linux:
    • Tested on Ubuntu 18.04
    • Install webgtk dependencies
      • Run sudo apt-get install libgtk-3-dev
      • Run sudo apt-get install libwebkit2gtk-4.0-dev
    • Run make prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run make linux-app
    • Uncompress linux/dist/focalboard-linux.tar.gz to a directory of your choice
    • Run focalboard-app from the directory you have chosen
  • Docker:
    • To run it locally from offical image:
      • docker run -it -p 80:8000 mattermost/focalboard
    • To build it for your current architecture:
      • docker build -f docker/Dockerfile .
    • To build it for a custom architecture (experimental):
      • 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.

Unit testing

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

  • Server unit tests: make server-test
  • Web app ESLint: cd webapp; npm run check
  • Web app unit tests: cd webapp; npm run test
  • Web app UI tests: cd webapp; npm run cypress:ci

Staying informed