luisgulo/focalboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
2610 commits 140 branches 167 tags 134 MiB
TypeScript 51.8%
Go 40.5%
SCSS 4%
HTML 1.4%
Makefile 0.5%
Other 1.7%
Find a file
Scott Bishel f441441cb4
GH-2877 - Style Autocomplete Modal (#2934) 
* style autocomplete modal

* lint fixes

* Only show profile picture for plugin

* add non plugin test, update plugin test
2022-04-27 09:13:23 -06:00
.github Bump versions of github actions, golangci-lint, and Go (#2844) 2022-04-19 21:18:47 -04:00
.vscode Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
build
docker Fix configuration for prometheus address (#2763) 2022-04-12 17:43:29 -04:00
docker-testing
docs Minor updates to the contributor's guide (#2526) 2022-03-11 12:20:59 -08:00
experiments/webext Update focalboard endpoints to v2 namespace (#2781) 2022-04-13 15:24:32 -05:00
import fix trello import 2022-03-31 22:55:08 -04:00
linux Initialise the store with a single user flag and pass it to the migrations (#2906) 2022-04-27 15:11:27 +02:00
mac Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
mattermost-plugin Implement Boards Data Retention - Take 2 (#2859) 2022-04-25 12:58:08 -06:00
server Initialise the store with a single user flag and pass it to the migrations (#2906) 2022-04-27 15:11:27 +02:00
webapp GH-2877 - Style Autocomplete Modal (#2934) 2022-04-27 09:13:23 -06:00
website Fix Main page LInks (#2919) 2022-04-25 08:50:35 -07:00
win-wpf Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
.dockerignore
.editorconfig
.gitignore Add Go code coverage report to CI (#2914) 2022-04-22 15:57:35 -07:00
.gitlab-ci.yml
app-config.json
CHANGELOG.md Update CHANGELOG.md for v0.15 2022-03-04 10:21:04 -05:00
config.json Fix configuration for prometheus address (#2763) 2022-04-12 17:43:29 -04:00
CONTRIBUTING.md Minor fixes to Focalboard docs (#2665) 2022-03-29 18:58:33 +02:00
Dockerfile.build Pin the FROM in dockerfiles. This prevents supply chain attacks where the latest image is replaced with a malicious version. (#2302) 2022-03-18 10:57:26 -07:00
LICENSE.txt
Makefile Add Go code coverage report to CI (#2914) 2022-04-22 15:57:35 -07:00
modd-servertest.conf Permissions feature branch (#2578) 2022-03-22 08:24:34 -06:00
modd-watchplugin.conf
modd.conf Permissions feature branch (#2578) 2022-03-22 08:24:34 -06:00
NOTICE.txt
README.md Minor fixes to Focalboard docs (#2665) 2022-03-29 18:58:33 +02:00
responsible_disclosure_policy.md
SECURITY.md Add SECURITY.md (#2349) 2022-03-18 10:55:50 -07:00
server-config.json Fix configuration for prometheus address (#2763) 2022-04-12 17:43:29 -04:00

README.md

Focalboard

CI Status CodeQL Dev Release Prod Release Translation status

Like what you see? 👀 Give us a GitHub Star! ⭐

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 main editions:

  • Personal Desktop: A standalone, single-user Mac, Windows, or Linux desktop app for your own todos and personal projects.

  • Mattermost Boards: A self-hosted or cloud server for your team to plan and collaborate.

Focalboard can also be installed as a standalone Personal Server for development and personal use.

Try Focalboard

Personal Desktop (Windows, Mac or Linux Desktop)

Mattermost Boards

Mattermost Boards is the Mattermost plugin version of Focalboard that combines project management tools with messaging and collaboration for teams of all sizes. To access and use Mattermost Boards, install or upgrade to Mattermost v6.0 or later as a self-hosted server or Cloud server. After logging into Mattermost, select the menu in the top left corner and select Boards.

Mattermost Boards is installed and enabled by default in Mattermost v6.0 and later.

See the plugin setup guide for more details.

Personal Server

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

Contribute to Focalboard

Contribute code, bug reports, and ideas to the future of the Focalboard project. We welcome your input! Please see CONTRIBUTING for details on how to get involved.

Getting started

Our developer guide has detailed instructions on how to set up your development environment for the Personal Server. It also provides more information about contributing to our open source community.

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 win-wpf-app
    • Run cd win-wpf/msix && focalboard.exe
  • Mac:
    • Requires macOS 11.3+ and Xcode 13.2.1+
    • make mac-app
    • open mac/dist/Focalboard.app
  • Linux:
    • Tested on Ubuntu 18.04
    • Install webgtk dependencies
      • sudo apt-get install libgtk-3-dev
      • sudo apt-get install libwebkit2gtk-4.0-dev
    • 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

Translating

Help translate Focalboard! The app is already translated into several languages. We welcome corrections and new language translations! You can add new languages or improve existing translations at Weblate.

Staying informed

Are you interested in influencing the future of the Focalboard open source project? Here's how you can get involved: