2021-01-26 20:13:05 +01:00
# Focalboard
2021-06-18 07:41:28 +02:00
2021-03-07 01:12:43 +01:00
Like what you see? :eyes: Give us a GitHub Star! :star:
2021-01-29 00:10:40 +01:00
[](https://www.focalboard.com)
2021-01-27 00:54:21 +01:00
2021-05-26 12:34:42 +02:00
[Focalboard ](https://www.focalboard.com ) is an open source, self-hosted alternative to Trello, Notion, and Asana.
2021-03-05 14:29:30 +01:00
It helps define, organize, track and manage work across individuals and teams. Focalboard comes in two editions:
2021-05-26 12:34:42 +02:00
* **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.
2021-03-20 17:34:28 +01:00
* **Focalboard Personal Server**: A self-hosted server for your team to collaborate.
2021-01-26 20:13:05 +01:00
2021-03-24 20:43:50 +01:00
The same MIT-licensed binary powers both desktop and server editions.
2020-10-08 18:26:05 +02:00
2021-05-26 12:34:42 +02:00
## Try out Focalboard
2021-03-18 12:27:09 +01:00
2021-03-20 16:32:46 +01:00
**Focalboard Personal Desktop (Windows, Mac or Linux Desktop)**
2021-03-18 12:53:10 +01:00
2021-05-26 12:34:42 +02:00
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.
2021-03-18 12:53:10 +01:00
2021-03-20 11:33:37 +01:00
If you're running a Linux Desktop, [download the latest `focalboard-linux.tar.gz` release ](https://github.com/mattermost/focalboard/releases ), unpack the `.tar.gz` archive, and open `focalboard-app` from the `focalboard-app` folder.
2021-05-26 12:34:42 +02:00
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 ](https://github.com/mattermost/focalboard/issues/99 ) (please upvote the ticket if you're interested in this addition).
2021-03-18 12:53:10 +01:00
**Focalboard Personal Server (Ubuntu)**
You can download and run the compiled **Focalboard Personal Server** by following [our latest install guide ](https://www.focalboard.com/download/personal-edition/ubuntu/ ).
2021-04-24 05:31:07 +02:00
Download the latest server release from [GitHub releases ](https://github.com/mattermost/focalboard/releases )
2021-03-18 12:27:09 +01:00
2020-10-26 20:45:40 +01:00
## Building the server
2020-10-08 18:26:05 +02:00
2021-02-04 00:25:38 +01:00
Please refer to the [Developer's Tips & Tricks ](https://www.focalboard.com/contribute/getting-started/dev-tips/ ) for more detailed steps. Here's a summary:
First, install basic dependencies:
* Go 1.15+
* Node 10+ and npm
* Mingw64 on Windows
2021-01-29 21:41:25 +01:00
2020-10-08 18:26:05 +02:00
```
2020-10-09 19:25:05 +02:00
make prebuild
2020-10-08 18:26:05 +02:00
make
```
2020-10-26 20:45:40 +01:00
## Running and testing the server
2020-10-08 18:29:48 +02:00
2021-01-28 23:23:52 +01:00
To start the server, run `./bin/focalboard-server`
2020-10-08 18:29:48 +02:00
Server settings are in config.json.
Open a browser to [http://localhost:8000 ](http://localhost:8000 ) to start.
2020-10-26 20:45:40 +01:00
2020-11-07 19:50:34 +01:00
## Building and running standalone desktop apps
2020-10-26 20:45:40 +01:00
2020-11-07 19:50:34 +01:00
You can build standalone apps that package the server to run locally against SQLite:
* Mac:
* `make mac-app`
2021-01-26 20:13:05 +01:00
* run `mac/dist/Focalboard.app`
2021-02-04 00:25:38 +01:00
* *Requires: macOS Catalina (10.15)+, Xcode 12+.*
2020-11-07 19:50:34 +01:00
* Linux:
2021-01-19 21:25:46 +01:00
* Install webgtk dependencies
* `sudo apt-get install libgtk-3-dev`
* `sudo apt-get install libwebkit2gtk-4.0-dev`
2020-11-07 19:50:34 +01:00
* `make linux-app`
2021-01-26 20:13:05 +01:00
* run `linux/dist/focalboard-app`
2021-01-29 21:41:25 +01:00
* *Tested with: Ubuntu 18.04*
2021-01-30 02:07:45 +01:00
* Windows:
2021-01-29 21:41:25 +01:00
* Open a git-bash prompt
2021-03-05 02:08:05 +01:00
* `make win-wpf-app`
* run `cd win-wpf/msix && focalboard.exe`
2020-11-07 19:50:34 +01:00
* *Requires: Windows 10*
2020-10-26 20:45:40 +01:00
2021-01-19 21:25:46 +01:00
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.
2021-01-20 19:01:32 +01:00
## Unit tests
2021-04-19 11:34:23 +02:00
Before checking-in commits, run: `make ci` , which is similar to the ci.yml workflow and includes:
2021-01-20 19:01:32 +01:00
* 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`
2021-03-04 18:40:53 +01:00
2021-03-04 18:46:27 +01:00
## Stay informed on progress
* **Changelog**: See [CHANGELOG.md ](CHANGELOG.md ) for the latest updates
2021-03-20 03:08:25 +01:00
* **Developer Discussion**: Join the [Developer Discussion ](https://github.com/mattermost/focalboard/discussions ) board
2021-05-26 12:34:42 +02:00
* **Chat**: Join the [Focalboard community channel ](https://community.mattermost.com/core/channels/focalboard )
2021-03-04 18:46:27 +01:00
2021-05-26 12:34:42 +02:00
## Share your feedback
2021-03-18 12:19:12 +01:00
2021-04-24 05:31:07 +02:00
File bugs, suggest features, join our forum, learn more [here ](https://github.com/mattermost/focalboard/wiki/Share-your-feedback )!
2021-03-18 12:19:12 +01:00
2021-03-04 18:40:53 +01:00
## Contributing
Contribute code, bug reports, and ideas to the future of the Focalboard project. We welcome your input! Please see [CONTRIBUTING.md ](CONTRIBUTING.md ) for details on how to get involved.
