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.
1808 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
Julien Fabre 0434e7d6b6
chore: Add test units for contentRegistry (#1521)
2021-10-12 17:03:54 -06:00
.github run all CI on PRs to be merged with release branches (#1390) 2021-10-01 10:24:21 -04:00
.vscode Implement Date ranges (#660) 2021-08-06 10:44:01 -06:00
build Update MIT-COMPILED-LICENSE.md 2021-03-19 18:26:59 -07:00
docker Remove duplicated restart on docker compose (#1067) 2021-08-23 16:38:34 +02:00
import Add the ability to import checklists from Trello (#1430) 2021-10-04 16:08:29 -07:00
linux MM-38342 plugin logging (#1193) 2021-09-15 09:01:05 -04:00
mac Update version to v0.9.1 2021-09-17 12:56:47 -07:00
mattermost-plugin Updating splash screen sizing for image and content (#1399) 2021-10-04 16:58:56 -04:00
server Change the unregistered connection logline to debug level (#1494) 2021-10-08 11:59:21 +02:00
webapp chore: Add test units for contentRegistry (#1521) 2021-10-12 17:03:54 -06:00
website Update dev tips (#1504) 2021-10-11 08:23:07 -07:00
win-wpf Update version to v0.9.1 2021-09-17 12:56:47 -07:00
.dockerignore docker: fix docker file image and apply some good practices (#552) 2021-07-01 11:46:03 +02:00
.editorconfig Adding initial coding style checking 2020-10-15 01:02:41 +02:00
.gitignore Remove enterprise symlink (#589) 2021-06-18 07:48:01 +02:00
.gitlab-ci.yml add variable to define the image (#581) 2021-06-15 14:00:05 +02:00
app-config.json Fix indentation 2021-02-10 10:13:04 -08:00
CHANGELOG.md Update changelog for v0.9 2021-08-09 14:21:03 -07:00
config.json Config for share board (#1187) 2021-09-16 13:31:02 -06:00
CONTRIBUTING.md Update CONTRIBUTING.md (#1342) 2021-09-28 19:57:24 +02:00
Dockerfile.build docker: fix docker file image and apply some good practices (#552) 2021-07-01 11:46:03 +02:00
LICENSE.txt License product name 2021-01-26 13:55:35 -08:00
Makefile Live Watch make target for improve the development experience (#1389) 2021-10-04 10:06:54 +02:00
modd-servertest.conf Remove indir directive as it's causing problems in OSX systems (#1328) 2021-09-24 21:01:05 +02:00
modd-watchplugin.conf Remove indir directive as it's causing problems in OSX systems (#1328) 2021-09-24 21:01:05 +02:00
modd.conf Remove indir directive as it's causing problems in OSX systems (#1328) 2021-09-24 21:01:05 +02:00
NOTICE.txt @mention support (#1147) 2021-09-13 15:36:36 -04:00
README.md Use cross-env instead of win-node-env (#656) 2021-07-15 19:30:22 -07:00
responsible_disclosure_policy.md Update responsibile_disclosure_policy.md (#1383) 2021-10-01 13:39:00 +02:00
server-config.json Workspace switcher (#1052) 2021-09-08 10:22:03 +05:30

README.md

Focalboard

CI Status Mac Build Ubuntu Build Windows Build CodeQL Dev Release Plugin Release Prod Release

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

Focalboard

Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.

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

  • Focalboard Personal Desktop: A stand-alone desktop app for your todos and personal projects. This is a single-tenant locally run server running Focalboard for optimal speed and performance.

  • Focalboard Personal Server: A self-hosted server for your team to collaborate.

The same MIT-licensed binary powers both desktop and server editions.

Try out Focalboard

Focalboard Personal Desktop (Windows, Mac or Linux Desktop)

Try out Focalboard Personal Desktop by going to the Windows Store or the Apple AppStore, searching for Focalboard and installing to run the compiled version locally.

If you're running a Linux Desktop, download the latest focalboard-linux.tar.gz release, unpack the .tar.gz archive, and open focalboard-app from the focalboard-app folder.

Note: For Windows and Mac users, while we don't yet offer Focalboard Personal Desktop outside of Store-based installs, it is in consideration for the future (please upvote the ticket if you're interested in this addition).

Focalboard Personal Server (Ubuntu)

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

Download the latest server release from GitHub releases

Building the server

Please refer to the Developer's Tips & Tricks for more detailed steps. Here's a summary:

First, install basic dependencies:

  • Go 1.15+
  • Node 10+ and npm
  • Mingw64 on Windows
make prebuild
make

Running and testing the server

To start the server, run ./bin/focalboard-server

Server settings are in config.json.

Open a browser to http://localhost:8000 to start.

Building and running standalone desktop apps

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

  • Mac:
    • make mac-app
    • run mac/dist/Focalboard.app
    • Requires: macOS Catalina (10.15)+, Xcode 12+.
  • Linux:
    • Install webgtk dependencies
      • sudo apt-get install libgtk-3-dev
      • sudo apt-get install libwebkit2gtk-4.0-dev
    • make linux-app
    • run linux/dist/focalboard-app
    • Tested with: Ubuntu 18.04
  • Windows:
    • Open a git-bash prompt
    • make win-wpf-app
    • run cd win-wpf/msix && focalboard.exe
    • Requires: Windows 10

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 tests

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

  • Server unit tests: make server-test
  • Webapp eslint: cd webapp; npm run check
  • Webapp unit tests: cd webapp; npm run test
  • Webapp UI tests: cd webapp; npm run cypress:ci

Stay informed on progress

Share your feedback

File bugs, suggest features, join our forum, learn more here!

Contributing

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