Fix #1957 . Boards dev guide. (#2390 )

* Fix #1957. Boards dev guide.

* Remove incomplete link

* Clarify the config.json settings

* Recommend forking and cloning the repo

* Cleanup instructions

* make webapp before plugin deploy

2022-02-25 09:37:40 -08:00

6.2 KiB

Raw Blame History

Focalboard

Like what you see? 👀 Give us a GitHub Star! ⭐

Focalboard is an open source, multilingual, self-hosted project management tool that's an alternative to Trello, Notion, and Asana.

It helps define, organize, track and manage work across individuals and teams. Focalboard comes in two main editions:

Personal Desktop: A stand-alone single-user Mac, Windows, or Linux desktop app for your todos and personal projects.
Mattermost Boards: A self-hosted or cloud server for your team to plan and collaborate.

Focalboard can also be installed as a standalone personal server for development and personal use.

Try out Focalboard

Focalboard Personal Desktop (Windows, Mac or Linux Desktop)

Try out the single-user Focalboard Personal Desktop:

macOS: Download from the Mac App Store.
Windows: Download from the Windows App Store or download focalboard-win.zip from the latest release, unpack, and run Focalboard.exe
Linux Desktop: Download focalboard-linux.tar.gz from the latest release, unpack, and open focalboard-app

Mattermost Boards

Mattermost Boards combines project management tools with messaging and collaboration for teams of all sizes. To access and use Boards, install or upgrade to Mattermost v6.0 or later as a self-hosted server or Cloud server. After logging into Mattermost, select the menu in the top left corner of Mattermost and choose Boards.

See the setup guide for more details.

Focalboard Personal Server (Ubuntu)

You can download and run the compiled Focalboard Personal Server by following our latest install guide.

Download the latest server release from GitHub releases

Building the server

Most development can be done on the Personal Server edition. Please refer to the Developer's Tips & Tricks for more detailed steps. Here's a summary:

First, install basic dependencies:

Go 1.15+
Node 16.3+ 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 (or the path specified with --config).

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 11.3+, Xcode 13.2.1+
Linux:
- Install webgtk dependencies
  - sudo apt-get install libgtk-3-dev
  - sudo apt-get install libwebkit2gtk-4.0-dev
- make linux-app
- uncompress linux/dist/focalboard-linux.tar.gz to a directory of your choice
- run focalboard-app from the directory you have chosen
- Tested with: Ubuntu 18.04
Windows:
- Open a git-bash prompt
- make win-wpf-app
- run cd win-wpf/msix && focalboard.exe
- Requires: Windows 10, Windows 10 SDK 10.0.19041.0, .NET 4.8 developer pack
Docker:
- To run it locally from Offical Image
- docker run -it -p 80:8000 mattermost/focalboard
- To Build it for your Current Architecture
- docker build -f docker/Dockerfile .
- To Build it for a custom Architecture (Experimental)
- docker build -f docker/Dockerfile --platform linux/arm64 .

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 similar 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

Changelog: See CHANGELOG.md for the latest updates
Developer Discussion: Join the Developer Discussion board
Chat: Join the Focalboard community channel

File bugs, suggest features, join our forum, learn more here!

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.

Translating

Help translate Focalboard! The app is already translated into several languages. We welcome corrections and new language translations! You can add new languages or improve existing translations at Weblate.

6.2 KiB Raw Blame History