Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matterpoll/matterpoll

Create polls and surveys directly within Mattermost
https://github.com/matterpoll/matterpoll

golang hacktoberfest mattermost mattermost-plugin

Last synced: 3 months ago
JSON representation

Create polls and surveys directly within Mattermost

Awesome Lists containing this project

README 

        
# ![Matterpoll Logo](images/logo.svg)



[![Build Status](https://img.shields.io/circleci/project/github/matterpoll/matterpoll/master.svg)](https://circleci.com/gh/matterpoll/matterpoll)

[![Code Coverage](https://img.shields.io/codecov/c/github/matterpoll/matterpoll/master.svg)](https://codecov.io/gh/matterpoll/matterpoll/branch/master)

[![Go Report Card](https://goreportcard.com/badge/github.com/matterpoll/matterpoll)](https://goreportcard.com/report/github.com/matterpoll/matterpoll)

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2588/badge)](https://bestpractices.coreinfrastructure.org/projects/2588)

[![Releases](https://img.shields.io/github/release/matterpoll/matterpoll.svg)](https://github.com/matterpoll/matterpoll/releases/latest)



Matterpoll is a plugin for [Mattermost](https://mattermost.com/). It allows users to create poll by using a slash command.



![Matterpoll plugin screenshot](images/screenshot.png)



## Installation



1. Download `com.github.matterpoll.matterpoll-x.y.z.tar.gz` from https://github.com/matterpoll/matterpoll/releases.

2. Upload `com.github.matterpoll.matterpoll-x.y.z.tar.gz` file through **System Console > Plugins > Plugin Management > Upload Plugin** in Mattermost and enable the plugin.

   * Upgrades can be performed by uploading the lastest release and confirm overwriting of the duplicate plugin ID.



## Settings

You can configure Matterpoll from **System Console > Plugins > Matterpoll**.



* **Trigger Word**: Change trigger word for poll command. (default `/poll`)

* **Experimental UI**: Enable new experimental UI for poll posts:

  - Change button color of voted answers

  - Hide poll management buttons (Add Option / Delete Poll / End Poll) from users who don't have permission

* **Default Settings**: Choose settings, that will be pre-selected in 'Create Poll' dialog. Settings will not be applied to `/poll` command.



Note: **Experimental UI** is not supported in Mattermost Mobile due to its limited support for plugin extension ([ref](https://github.com/mattermost/mattermost-mobile/issues/3883#issuecomment-1148519369)).



## Usage



`/poll "Is Matterpoll great?"` creates a poll with the answer options "Yes" and "No". You can also leave out the double quotes and just type `/poll Is Matterpoll great?`.



If you want to define all answer options by yourself, type `/poll "Is Matterpoll great?" "Of course" "In any case" "Definitely"`- Note that the double quotes are required in this case.



`/poll` show up a modal for creating a poll.



### Poll Settings



Poll Settings provide further customisation, e.g. `/poll "Is Matterpoll great?" "Of course" "In any case" "Definitely" --progress --anonymous`. The available Poll Settings are:

- `--anonymous`: Don't show who voted for what at the end

- `--progress`: During the poll, show how many votes each answer option got and, in post card, show who voted for which answers ([#431](https://github.com/matterpoll/matterpoll/pull/431))

- `--public-add-option`: Allow all users to add additional options

- `--votes=X`: Allow users to vote for X options



## Localization



Matterpoll supports localization of user specify messages. You can change language of poll message by setting it in **System Console > Site Configuration > Localization > Default Server Language**. Language of messages that only a user can see (e.g.: help messages, error messages) use the language set in **Settings > Display > Language**.



The currently supported languages are:

- English

- French

- German

- Japanese

- Korean

- Polish

- Russian

- Simplified Chinese

- Spanish

- Traditional Chinese



## Troubleshooting



#### Pressing the poll buttons does nothing and creates a 400 error in the Mattermost log



Make sure to set your [Site URL](https://docs.mattermost.com/configure/configuration-settings.html?highlight=site%20url#site-url) properly.

For example, this error happens in case you set SiteURL starting with `http://`, in spite of running Mattermost server through https.



#### Plugin upload causes "Received invalid response from the server."



Ensure that the "Maximum File Size" (System Console > File Storage) is set to be larger than the `com.github.matterpoll.matterpoll-x.y.z.tar.gz` file.



## Contributing



We welcome contributions for bug reports, issues, feature requests, feature implementations and pull requests. Feel free to [**file a new issue**](https://github.com/matterpoll/matterpoll/issues/new/choose) or join the [**Matterpoll channel**](https://community.mattermost.com/core/channels/matterpoll) on the Mattermost community server.



For a complete guide on contributing to Matterpoll, see the [Contribution Guideline](CONTRIBUTING.md).