self-hosted/focalboard
1
0
Fork 0
mirror of https://github.com/mattermost/focalboard.git synced 2024-11-27 08:31:20 +02:00
Code Issues Releases Activity
Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
630 Commits 143 Branches 168 Tags 129 MiB
TypeScript 54%
Go 40.4%
SCSS 4.1%
Swift 0.5%
C# 0.4%
Other 0.5%
f4de57e93b
Go to file
coreyhulen f4de57e93b Adding license
2021-01-22 12:02:52 -08:00
.github/workflows ubuntu: apt-get update 2021-01-20 14:47:48 -08:00
.vscode Fix Go integration tests 2021-01-05 19:47:18 -08:00
linux Move app config to app-config.json 2021-01-20 14:09:41 -08:00
mac Move app config to app-config.json 2021-01-20 14:09:41 -08:00
server make generate 2021-01-21 10:25:35 -08:00
webapp Comment out export board archive (incomplete tree) 2021-01-22 11:25:34 -08:00
website Website hero image width 2021-01-22 11:25:45 -08:00
win Update to latest Lorca for chrome path 2021-01-20 20:28:43 -08:00
.editorconfig Adding initial coding style checking 2020-10-15 01:02:41 +02:00
.gitignore Move app config to app-config.json 2021-01-20 14:09:41 -08:00
app-config.json Move app config to app-config.json 2021-01-20 14:09:41 -08:00
config.json Adding config for session expire and refresh 2021-01-11 15:16:39 +01:00
LICENSE.txt Adding license 2021-01-22 12:02:52 -08:00
Makefile windows octoserver.exe path 2021-01-20 15:23:33 -08:00
README.md Update readme 2021-01-20 10:01:32 -08:00

README.md

mattermost-octo-tasks

Building the server

make prebuild
make

Currently tested with:

  • Go 1.15.2
  • MacOS Catalina (10.15.6)
  • Ubuntu 18.04
  • Windows 10

The server defaults to using SQLite as the store, but can be configured to use Postgres:

  • 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

Running and testing the server

To start the server, run ./bin/octoserver

Server settings are in config.json.

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/Tasks.app
    • Requires: macOS Catalina (10.15), Xcode 12 and a development signing certificate.
  • Linux:
    • Install webgtk dependencies
      • sudo apt-get install libgtk-3-dev
      • sudo apt-get install libwebkit2gtk-4.0-dev
    • make linux-app
    • run linux/dist/tasks-app
  • Windows
    • make win-app
    • run win/dist/tasks-win.exe
    • Requires: Windows 10

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