2021-01-26 20:13:05 +01:00
# Focalboard
Focalboard is an open source project management app for individuals and teams. It comes in two editions:
* **Personal Desktop**: A stand-alone desktop app for your todos and personal projects
* **Personal Server**: A self-hosted server for your team to collaborate
The same server binary powers both editions.
2020-10-08 18:26:05 +02:00
2020-10-26 20:45:40 +01:00
## Building the server
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
```
Currently tested with:
* Go 1.15.2
2020-10-08 19:01:56 +02:00
* MacOS Catalina (10.15.6)
2020-10-26 20:45:40 +01:00
* Ubuntu 18.04
2020-11-07 19:50:34 +01:00
* Windows 10
2020-10-08 19:01:56 +02:00
2020-11-07 19:50:34 +01:00
The server defaults to using SQLite as the store, but can be configured to use Postgres:
2020-10-08 19:01:56 +02:00
* In config.json
* Set dbtype to "postgres"
* Set dbconfig to the connection string (which you can copy from dbconfig_postgres)
* Create a new "octo" database with psql
* Restart the server
2020-10-08 18:29:48 +02:00
2020-10-26 20:45:40 +01:00
## Running and testing the server
2020-10-08 18:29:48 +02:00
2020-11-07 19:50:34 +01:00
To start the server, run `./bin/octoserver`
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`
2020-11-07 19:50:34 +01:00
* *Requires: macOS Catalina (10.15), Xcode 12 and a development signing certificate.*
* 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`
2020-11-07 19:50:34 +01:00
* Windows
* `make win-app`
2021-01-26 20:13:05 +01:00
* run `win/dist/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
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`
