Skip to content

Latest commit

 

History

History
178 lines (130 loc) · 7.45 KB

README.md

File metadata and controls

178 lines (130 loc) · 7.45 KB
Raw

NeoBoard

Build Matrix

A collaborative whiteboard widget for Element, based on Matrix. Use it to collaborate in real-time with your peers, by keeping full control of your data and keep it secure with end-to-end encryption.

A screenshot of the NeoBoard showing the drawing board, a list of different slides, and the cursors of the collaborators Alicia and Jim.
A whiteboard showing a Kanban board with three columns: to do, in progress, done. A whiteboard showing a board to moderate a lean coffee. A whiteboard showing a mindmap to collect ideas. A whitboard showing an empty SWOT analysis to collect strengths, weaknesses, opportunities, and threats.

All data is stored in the Matrix rooms. Learn more about the architecture in the Model or the Architecture Decision Records.

Demo

Click here and follow the instructions to see it in action and experience it yourself. You need at least Moderator permissions (power level >50) in the room so it might be a good idea to test it in a new Matrix room at first.

This is only a demo deployment that is not suited for production use. See the Deployment section on how you can host the widget on your own.

💡 Import the NeoBoard quick start pack for some demo content to get started right away.

Getting Started

Development on the widget happens at GitHub.

How to Contribute

Please take a look at our Contribution Guidelines. Check the following steps to develop for the widget:

Requirements

You need to install Node.js (>= 20.0.0, prefer using an LTS version) and run yarn to work on this package. The minimal Element version to use this widget is 1.11.8.

Installation

After checkout, run yarn install to download the required dependencies

Warning Do not use npm install when working with this package.

Configuration

Rename the provided .env.local.default to .env.local and fill it with your configuration. For a list of available options, see Configuration.

Running the Widget Locally

Follow the instructions to run the widget locally. Visit the widget url follow the further instructions: http://localhost:5273/ or https://localhost:5274/ .

Running with a local version of the matrix-widget-toolkit

If changes inside matrix-widget-toolkit are required or for debugging purposes, you can clone the repos next to each other and link the packages with yarn link:

ls
matrix-neoboard
matrix-widget-toolkit

Then yarn link the required matrix-widget-toolkit packages, for example:

cd matrix-widget-toolkit
yarn install
cd packages/api
yarn link
cd ../../../matrix-neoboard
yarn link @matrix-widget-toolkit/api
yarn install

Available Scripts

In the project directory, you can run:

  • yarn dev: Start the widget for development.
  • yarn dev:https: Start the widget for development with a self-signed HTTPS certificate.
  • yarn build: Build the production version of the widget.
  • yarn preview: Preview a production build of the widget.
  • yarn preview:https: Preview a production build of the widget with a self-signed HTTPS certificate.
  • yarn test: Watch all files for changes and run tests.
  • yarn tsc: Check TypeScript types for errors in the widget.
  • yarn lint: Run eslint on the widget.
  • yarn prettier:write: Run prettier on all files to format them.
  • yarn depcheck: Check for missing or unused dependencies.
  • yarn deduplicate: Deduplicate dependencies in the yarn.lock file.
  • yarn changeset: Generate a changeset that provides a description of a change.
  • yarn translate: Update translation files from code.
  • yarn generate-disclaimer: Generates license disclaimer and include it in the build output.
  • yarn docker:build: Builds a container from the output of yarn build and yarn generate-disclaimer.
  • yarn docker:run: Runs the container and serves the widget at http://localhost:3000.

Versioning

This package uses automated versioning. Each change should be accompanied by a specification of the impact (patch, minor, or major) and a description of the change. Use yarn changeset to generate a new changeset for a pull request. Learn more in the .changeset folder.

Once the change is merged to main, a “Version Packages” pull request will be created. As soon as the project maintainers merged it, the package will be released and the container is published.

Architecture Decision Records

We use Architecture Decision Records (ADR)s to document decisions for our software. You can find them at /docs/adrs.

Deployment

Yon can run the widget using Docker:

docker run --rm -e REACT_APP_HOME_SERVER_URL=https://matrix-client.matrix.org -p 8080:8080 ghcr.io/nordeck/matrix-neoboard-widget:latest

We also provide a HELM chart.

Important: The collaboration features require you to configure TURN servers in your Homeserver. It can work without them, but there is a high chance that it won't! The official matrix.org homeserver will work; see for example how to configure them for Synapse.

Verify the Container Images

The container images releases are signed by cosign using identity-based ("keyless") signing and transparency. Execute the following command to verify the signature of a container image:

cosign verify \
--certificate-identity-regexp https://github.com/nordeck/matrix-neoboard/.github/workflows/publish-release.yml@refs/tags/v \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
ghcr.io/nordeck/matrix-neoboard-widget:<version> | jq

License

This project is licensed under APACHE 2.0.

The disclaimer for other OSS components can be accessed via the /NOTICE.txt endpoint. The list of dependencies and their licenses are also available in a machine readable format at /usr/share/nginx/html/licenses.json in the container image.

Sponsors

dPhoenixSuite      Dataport      Nordeck

This project is part of the dPhoenixSuite by Dataport.