luisgulo/focalboard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
901 Commits 140 Branches 167 Tags 134 MiB
TypeScript 51.8%
Go 40.5%
SCSS 4%
HTML 1.4%
Makefile 0.5%
Other 1.7%
5c802347be
Go to file
it33 5c802347be
Noting speed advantage of desktop version 
Responding to HackerNews comments: 
https://news.ycombinator.com/reply?id=26501393&goto=item%3Fid%3D26499062%2326501393
2021-03-18 04:06:12 -07:00
.github
.vscode
build
import
linux
mac Mac: Remove Print and unused menu items 2021-03-11 13:45:37 -08:00
server Register Request email validation 2021-03-18 10:32:23 +03:00
webapp Fix #78: GetSharing should return undefined when missing 2021-03-17 12:15:16 -07:00
website Merge pull request #80 from mantlecurve/patch-1 2021-03-18 11:38:43 +01:00
win-wpf Update appx version 2021-03-08 09:51:28 -08:00
.editorconfig
.gitignore Register Request email validation 2021-03-18 10:32:23 +03:00
app-config.json
CHANGELOG.md Update changelog 2021-03-15 13:20:58 -07:00
config.json
CONTRIBUTING.md Update core contributor list 2021-03-06 17:08:22 -08:00
Dockerfile Remove apt upgrade following comments on various platforms 2021-03-18 10:04:03 +00:00
LICENSE.txt
Makefile Fix #82: Build webapp with plain make 2021-03-17 23:31:55 -07:00
NOTICE.txt
README.md Noting speed advantage of desktop version 2021-03-18 04:06:12 -07:00
responsibile_disclosure_policy.md Adding responsible disclosure policy 2021-03-05 05:38:21 -08:00
server-config.json

README.md

Focalboard

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 server binary powers both editions.

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
    • Install win-node-env npm install -g win-node-env
    • 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 simlar 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

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.