self-hosted/focalboard
1
0
Fork 0
mirror of https://github.com/mattermost/focalboard.git synced 2024-11-24 08:22:29 +02:00
Code Issues Releases Activity
Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
3,596 Commits 143 Branches 168 Tags 129 MiB
TypeScript 54%
Go 40.4%
SCSS 4.1%
Swift 0.5%
C# 0.4%
Other 0.5%
5dfd402e26
Go to file
Miguel de la Cruz 5dfd402e26
Unify and enhance block validation (#4790) 
* Adds limit check for block titles

* Adds limit check for the aggregation of the fields

* Fix linter

* Adds tests

* Fix err check method order
2023-06-26 13:37:37 -06:00
.github Update ubuntu version to use latest LTS (#4771) 2023-06-09 10:44:15 -06:00
.vscode Add readme for Mac and Win apps (#2757) 2022-04-12 09:20:36 -07:00
docker [GH-124] Added Docker Arm64 Capability (#1700) 2022-11-11 10:28:23 -05:00
docker-testing Idempotent schema and data migrations (#4253) 2022-12-16 11:15:38 -05:00
docs Minor updates to the contributor's guide (#2526) 2022-03-11 12:20:59 -08:00
experiments/webext update webapp dependencies (#3317) 2022-07-06 10:42:50 -06:00
import Update URL to docs page for migrating and reference .boardarchive (#4043) 2022-10-19 13:33:06 -06:00
linux Remove product references (#4744) 2023-05-31 15:52:44 -06:00
mac Update Boards version to 7.3 (#3382) 2022-07-18 12:05:59 -06:00
mattermost-plugin Remove product references (#4744) 2023-05-31 15:52:44 -06:00
noticegen [feat] Notice.txt generation configuration 2022-07-19 09:20:39 +03:00
server Unify and enhance block validation (#4790) 2023-06-26 13:37:37 -06:00
webapp Fix boards share dialog (#4761) 2023-06-07 16:39:44 -06:00
website Focalboard Website Update V2 (#4391) 2023-01-25 07:37:34 +05:00
win-wpf update to version 7.2.0 2022-05-11 17:25:46 -06:00
.dockerignore [GH-124] Added Docker Arm64 Capability (#1700) 2022-11-11 10:28:23 -05:00
.editorconfig Adding initial coding style checking 2020-10-15 01:02:41 +02:00
.gitattributes Git attributes for ignoring website and swagger docs in linguist added. (#3172) 2022-06-12 09:18:44 -07:00
.gitignore Remove product references (#4744) 2023-05-31 15:52:44 -06:00
.gitlab-ci.yml MM-49703: Bump to Go 1.19 (#4489) (#4502) 2023-01-23 12:43:40 +05:30
.gitpod.yml Create .gitpod.yml (#3010) 2022-05-03 13:46:04 -04:00
app-config.json Fix indentation 2021-02-10 10:13:04 -08:00
CHANGELOG.md Update CHANGELOG.md for v0.15 2022-03-04 10:21:04 -05:00
config.json Fix configuration for prometheus address (#2763) 2022-04-12 17:43:29 -04:00
CONTRIBUTING.md Minor fixes to Focalboard docs (#2665) 2022-03-29 18:58:33 +02:00
Dockerfile.build Enable cross-compilation of Linux webapp via Docker (#4528) 2023-03-09 11:53:45 -05:00
LICENSE.txt License product name 2021-01-26 13:55:35 -08:00
Makefile Remove product references (#4744) 2023-05-31 15:52:44 -06:00
modd-servertest.conf Add sqlite3 tag to modd files and linux app build (#4218) 2022-11-16 16:51:25 +01: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 Add sqlite3 tag to modd files and linux app build (#4218) 2022-11-16 16:51:25 +01:00
NOTICE.txt @mention support (#1147) 2021-09-13 15:36:36 -04:00
pull_request_template.md Update pull_request_template.md (#3487) 2022-07-29 22:14:52 +02:00
README.md Update README.md 2023-04-24 17:01:21 -04: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 Fix configuration for prometheus address (#2763) 2022-04-12 17:43:29 -04:00

README.md

⚠️ Announcement: PLEASE READ ⚠️

Focalboard Personal Server and Personal Desktop editions will transition to being fully community supported as of April 30th, 2023. This Focalboard repository will become the Personal Edition repository, and will remain open indefinitely. However, we won’t be adding any new enhancements, and will only address Sev-1 level bugs until April 30th, 2023.

The Boards plugin version will be integrated into Mattermost as a core in-product feature, and will no longer be supported as a plugin as of release v7.11 (May 2023). The plugin code will be merged into the Mattermost-server repository where future enhancements will be added to moving forward. New pull requests and issues should be filed against https://github.com/mattermost/mattermost-server.

Please see this dicussion for more details.

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 three editions:

Try Focalboard

Mattermost Boards

Mattermost Boards 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. After logging into Mattermost, select the menu in the top left corner and select Boards.

Personal Desktop (Windows, Mac or Linux Desktop)

Personal Server

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

API Docs

Boards API docs can be found over at https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html

Contribute to Focalboard

For anyone interested in being an official maintainer of the Focalboard repository, please reach out to us on our Focalboard Community Channel. If there are no maintainers, and you’re still interested in adding your own improvements to the Focalboard Personal Editions, we encourage you to fork and maintain the repository.

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.

Clone mattermost-server into sibling directory.

Create an .env file in the focalboard directory that contains:

EXCLUDE_ENTERPRISE="1"

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 prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run make win-wpf-app
    • Run cd win-wpf/msix && focalboard.exe
  • Mac:
    • Requires macOS 11.3+ and Xcode 13.2.1+
    • Run make prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run make mac-app
    • Run open mac/dist/Focalboard.app
  • Linux:
    • Tested on Ubuntu 18.04
    • Install webgtk dependencies
      • Run sudo apt-get install libgtk-3-dev
      • Run sudo apt-get install libwebkit2gtk-4.0-dev
    • Run make prebuild
    • The above prebuild step needs to be run only when you make changes to or want to install your npm dependencies, etc.
    • Once the prebuild is completed, you can keep repeating the below steps to build the app & see the changes.
    • Run 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