self-hosted/focalboard
1
0
Fork 0
mirror of https://github.com/mattermost/focalboard.git synced 2024-12-24 13:43:12 +02:00
Code Issues Releases Activity
Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
2,518 Commits 143 Branches 168 Tags 129 MiB
TypeScript 54%
Go 40.4%
SCSS 4.1%
Swift 0.5%
C# 0.4%
Other 0.5%
2b3ed75b3b
Go to file
Chen-I Lim 2b3ed75b3b
Add readme for Mac and Win apps (#2757) 
* Add readme for Mac and Win apps

* chore(Makefile): improve xcode error feedback

Co-authored-by: Paul Esch-Laurent <paul.esch-laurent@mattermost.com>
2022-04-12 09:20:36 -07:00
.github Generate templates archive at build time (#2577) 2022-03-30 18:10:11 -04:00
.vscode Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
build Update MIT-COMPILED-LICENSE.md 2021-03-19 18:26:59 -07:00
docker Pin the FROM in dockerfiles. This prevents supply chain attacks where the latest image is replaced with a malicious version. (#2302) 2022-03-18 10:57:26 -07:00
docker-testing Test all supported databases in CI (#2000) 2021-12-17 12:30:47 -05:00
docs Minor updates to the contributor's guide (#2526) 2022-03-11 12:20:59 -08:00
experiments/webext Bump minimist from 1.2.5 to 1.2.6 in /experiments/webext (#2615) 2022-03-23 17:31:45 -06:00
import fix trello import 2022-03-31 22:55:08 -04:00
linux Upgrading all the server libraries (#2643) 2022-03-25 17:05:56 -06:00
mac Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
mattermost-plugin Don't notify non-board members of card changes (#2718) 2022-04-07 11:42:32 -04:00
server Add coalesce to template version migration (#2764) 2022-04-12 08:47:45 -04:00
webapp Merge pull request #2741 from mattermost/delete-view-fix 2022-04-11 07:41:36 -06:00
website Streamline docs and fix broken links (#2656) 2022-03-29 10:14:10 +02:00
win-wpf Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
.dockerignore docker: fix docker file image and apply some good practices (#552) 2021-07-01 11:46:03 +02:00
.editorconfig Adding initial coding style checking 2020-10-15 01:02:41 +02:00
.gitignore Generate templates archive at build time (#2577) 2022-03-30 18:10:11 -04:00
.gitlab-ci.yml add variable to define the image (#581) 2021-06-15 14:00:05 +02:00
app-config.json revert bad config changes 2022-03-30 15:12:56 -06:00
CHANGELOG.md Update CHANGELOG.md for v0.15 2022-03-04 10:21:04 -05:00
config.json Sqlite in-memory database for unit tests (#2599) 2022-03-23 14:14:07 -04:00
CONTRIBUTING.md Minor fixes to Focalboard docs (#2665) 2022-03-29 18:58:33 +02:00
Dockerfile.build Pin the FROM in dockerfiles. This prevents supply chain attacks where the latest image is replaced with a malicious version. (#2302) 2022-03-18 10:57:26 -07:00
LICENSE.txt License product name 2021-01-26 13:55:35 -08:00
Makefile Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
modd-servertest.conf Permissions feature branch (#2578) 2022-03-22 08:24:34 -06:00
modd-watchplugin.conf Remove indir directive as it's causing problems in OSX systems (#1328) 2021-09-24 21:01:05 +02:00
modd.conf Permissions feature branch (#2578) 2022-03-22 08:24:34 -06:00
NOTICE.txt @mention support (#1147) 2021-09-13 15:36:36 -04:00
README.md Minor fixes to Focalboard docs (#2665) 2022-03-29 18:58:33 +02:00
responsible_disclosure_policy.md Update responsibile_disclosure_policy.md (#1383) 2021-10-01 13:39:00 +02:00
SECURITY.md Add SECURITY.md (#2349) 2022-03-18 10:55:50 -07:00
server-config.json Workspace switcher (#1052) 2021-09-08 10:22:03 +05:30

README.md

Focalboard

CI Status CodeQL Dev Release Prod Release Translation status

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

Focalboard

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 standalone, single-user Mac, Windows, or Linux desktop app for your own 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 Focalboard

Personal Desktop (Windows, Mac or Linux Desktop)

Mattermost Boards

Mattermost Boards is the Mattermost plugin version of Focalboard that combines project management tools with messaging and collaboration for teams of all sizes. To access and use Mattermost 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 and select Boards.

Mattermost Boards is installed and enabled by default in Mattermost v6.0 and later.

See the plugin setup guide for more details.

Personal Server

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

Contribute to Focalboard

Contribute code, bug reports, and ideas to the future of the Focalboard project. We welcome your input! Please see CONTRIBUTING for details on how to get involved.

Getting started

Our developer guide has detailed instructions on how to set up your development environment for the Personal Server. It also provides more information about contributing to our open source community.

To build the server:

make prebuild
make

To run the server:

 ./bin/focalboard-server

Then navigate your browser to http://localhost:8000 to access your Focalboard server. The port is configured in config.json.

Once the server is running, you can rebuild just the web app via make webapp in a separate terminal window. Reload your browser to see the changes.

Building and running standalone desktop apps

You can build standalone apps that package the server to run locally against SQLite:

  • Windows:
    • Requires Windows 10, Windows 10 SDK 10.0.19041.0, and .NET 4.8 developer pack
    • Open a git-bash prompt.
    • Run make win-wpf-app
    • Run cd win-wpf/msix && focalboard.exe
  • Mac:
    • Requires macOS 11.3+ and Xcode 13.2.1+
    • make mac-app
    • open mac/dist/Focalboard.app
  • Linux:
    • Tested on Ubuntu 18.04
    • 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
  • 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 testing

Before checking in commits, run make ci, which is similar to the .gitlab-ci.yml workflow and includes:

  • Server unit tests: make server-test
  • Web app ESLint: cd webapp; npm run check
  • Web app unit tests: cd webapp; npm run test
  • Web app UI tests: cd webapp; npm run cypress:ci

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.

Staying informed

Are you interested in influencing the future of the Focalboard open source project? Here's how you can get involved: