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.
946 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 3124216ddf
Merge pull request #139 from mattermost/it33-patch-3-1 
Adding Changelog update instructions
2021-03-19 18:39:28 -07:00
.github Add enhancement issue template 2021-03-18 13:45:02 -07:00
.vscode VSCode go.delveConfig settings 2021-03-19 09:41:03 -07:00
build Update MIT-COMPILED-LICENSE.md 2021-03-19 18:26:59 -07: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 Fix #117: Lower macOS min OS to 10.14 Mojave 2021-03-18 15:05:47 -07:00
server Fix #136: Update the displayed version 2021-03-19 09:59:46 -07:00
webapp Adding french support 2021-03-19 23:11:14 +01:00
website Fix #114: Update server install url to GitHub 2021-03-18 14:24:18 -07:00
win-wpf Update appx version 2021-03-08 09:51:28 -08:00
.editorconfig Adding initial coding style checking 2020-10-15 01:02:41 +02:00
.gitignore Register Request email validation 2021-03-18 10:32:23 +03:00
app-config.json Fix indentation 2021-02-10 10:13:04 -08:00
CHANGELOG.md Update changelog 2021-03-15 13:20:58 -07:00
config.json Fix indentation 2021-02-10 10:13:04 -08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-03-19 17:23:06 -07:00
Dockerfile Remove unnecessary binaries, update to use github releases 2021-03-19 08:25:21 +00:00
LICENSE.txt License product name 2021-01-26 13:55:35 -08:00
Makefile Fix #82: Build webapp with plain make 2021-03-17 23:31:55 -07:00
NOTICE.txt Add webapp/NOTICE.txt 2021-01-27 12:03:39 -08:00
README.md Adding "Share your feedback" 2021-03-18 04:19:12 -07: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

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

Share your feedback

File bugs, suggest features, join our forum, learn more here: https://github.com/mattermost/focalboard/wiki/Share-your-feedback!

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.