Skip to content

Latest commit

 

History

History
146 lines (105 loc) · 6.05 KB

README.md

File metadata and controls

146 lines (105 loc) · 6.05 KB
Raw

Matrix Poll

CI Matrix

This widget allows to conduct polls in Matrix rooms. But unlike MSC3381, it is designed for more complex scenarios, like polls with multiple parties in a council. You have full control over your data, as it's stored in your Matrix room.

It supports creating parties, assigning members to them, and handling representatives. You can prepare multiple polls in advance and then run through them in a session. After the registered users have voted, you can create a report with all results.

Create Poll Poll List Poll Reuslts Create Groups

Demo

Till now there is no officially hosted demo of the widget. See the Deployment section on how you can host the widget on your own.

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. The widget comes with two routes, visit them and follow the further instructions:

  • The poll widget itself, providing the voting view: http(s)://localhost:3000/
  • The admin widget, providing the group configuration: http(s)://localhost:3000/admin/

Available Scripts

In the project directory, you can run:

  • yarn dev: Start the widget for development.
  • yarn start: Start the widget for development with a self-signed HTTPS certificate.
  • yarn build: Build the production version of the widget.
  • 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.
  • yarn docker:stop: Stops the running container.
  • yarn docker:remove: Removes and stops the running container.

Versioning

This package uses automated versioning. Each change should be accompanied with 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-poll-widget:latest

We also provide a HELM chart.

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-poll/.github/workflows/publish-release.yml@refs/tags/v \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
ghcr.io/nordeck/matrix-poll-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 maschine 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.