Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nordeck/matrix-poll
This widget allows to conduct polls in Matrix rooms.
https://github.com/nordeck/matrix-poll
element hacktoberfest matrix matrix-widget-api nordeck
Last synced: about 1 month ago
JSON representation
This widget allows to conduct polls in Matrix rooms.
- Host: GitHub
- URL: https://github.com/nordeck/matrix-poll
- Owner: nordeck
- License: apache-2.0
- Created: 2022-11-03T08:08:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-13T14:46:21.000Z (about 1 month ago)
- Last Synced: 2024-11-13T14:49:08.223Z (about 1 month ago)
- Topics: element, hacktoberfest, matrix, matrix-widget-api, nordeck
- Language: TypeScript
- Homepage:
- Size: 2.32 MB
- Stars: 37
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-technostructure - nordeck/matrix-poll - poll: This widget allows to conduct polls in Matrix rooms. ([🔬 semantics](https://github.com/stars/ketsapiwiq/lists/semantics))
- awesome-technostructure - nordeck/matrix-poll - poll: This widget allows to conduct polls in Matrix rooms. ([🔬 semantics](https://github.com/stars/ketsapiwiq/lists/semantics))
README
# Matrix Poll
[](https://matrix.to/#/#nordeck:matrix.org)
This widget allows to conduct polls in Matrix rooms.
But unlike [MSC3381](https://github.com/matrix-org/matrix-spec-proposals/blob/travis/msc/polls/proposals/3381-polls.md), 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.
## Demo
Till now there is no officially hosted demo of the widget.
See the [Deployment](#deployment) section on how you can host the widget on your own.
## Getting Started
Development on the widget happens at [GitHub](https://github.com/nordeck/matrix-poll).
### How to Contribute
Please take a look at our [Contribution Guidelines](https://github.com/nordeck/.github/blob/main/docs/CONTRIBUTING.md).
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](./docs/configuration.md).
### Running the Widget Locally
Follow the [instructions to run the widget locally](https://github.com/nordeck/matrix-widget-toolkit/tree/main/example-widget-mui#running-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](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](./.changeset).
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](https://github.com/nordeck/matrix-widget-toolkit/blob/main/docs/adrs/adr001-use-adrs-to-document-decisions.md) to document decisions for our software.
You can find them at [`/docs/adrs`](./docs/adrs/).
## Deployment
Yon can run the widget using Docker:
```sh
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](./charts/).
## Verify the Container Images
The container images releases are signed by [cosign](https://github.com/sigstore/cosign) using identity-based ("keyless") signing and transparency.
Execute the following command to verify the signature of a container image:
```sh
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: | jq
```
## License
This project is licensed under [APACHE 2.0](./LICENSE).
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
   Â
   Â
This project is part of the [dPhoenixSuite by Dataport](https://www.dphoenixsuite.de/).