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.
833 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
Chen-I Lim ec3cb795b9
Merge pull request #59 from it33/patch-3 
Adding responsible disclosure policy
2021-03-05 09:26:20 -08:00
.github Remove old windows app 2021-03-04 17:09:51 -08:00
.vscode Fix indentation 2021-02-10 10:13:04 -08:00
build Add binary license file 2021-01-25 12:46:03 -08:00
import Use JSONL format for archive 2021-03-02 13:21:55 -08:00
linux Move single-user-token to environment var 2021-02-11 10:13:17 -08:00
mac Move single-user-token to environment var 2021-02-11 10:13:17 -08:00
server Windows WPF / UWP app 2021-03-01 11:36:36 -08:00
webapp Fixes #56; Preserve readonly token on view change 2021-03-04 10:39:58 -08:00
website Update feedback page 2021-03-04 12:14:52 -08:00
win-wpf Update AppxManifest 2021-03-04 17:06:50 -08:00
.editorconfig
.gitignore Add Swagger / OpenAPI docs 2021-02-17 11:29:20 -08:00
app-config.json Fix indentation 2021-02-10 10:13:04 -08:00
CHANGELOG.md Update changelog 2021-03-04 09:54:06 -08:00
config.json Fix indentation 2021-02-10 10:13:04 -08:00
CONTRIBUTING.md Add contributing.md 2021-03-04 09:40:53 -08:00
LICENSE.txt License product name 2021-01-26 13:55:35 -08:00
Makefile Remove old windows app 2021-03-04 17:09:51 -08:00
NOTICE.txt Add webapp/NOTICE.txt 2021-01-27 12:03:39 -08:00
README.md Proposing tweak for SEO 2021-03-05 05:29:30 -08:00
responsibile_disclosure_policy.md Adding responsible disclosure policy 2021-03-05 05:38:21 -08:00
server-config.json Rename admin local socket 2021-02-01 10:31:06 -08:00

README.md

Focalboard

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