KazuAlex / openpollslack

Open source poll slack app
69 stars 20 forks source link

Open source poll for slack

Welcome to the open source poll for slack.
This repository is hosted on GitLab. Github repository is only a mirror.
But feel free to open new issues on both.

Important update

If you have an error when submitting poll, please use the "Add to slack" button on site to re-authorize the bot on your workspace

Migrate to v3

To upgrade to v3, you need to have a mongo database.
Setup your config/default.json with new database url and database name:

After that, migrate your old database to the mongo with the script:
At the root directory, run ./scripts/migrate-v3.sh [MONGO_URL] [MONGO_DB_NAME]
Replace [MONGO_URL] by the same mongo_url and [MONGO_DB_NAME] with the same mongo_db_name set in your config/default.json.
As an example, with the default data from config/default.json.dist, the command line to migrate is:

./scripts/migrate-v3.sh mongodb://localhost:27017 open_poll

License

The code is under GNU GPL license. So, you are free to modify the code and redistribute it under same license.

Remember the four freedoms of the GPL :

  • the freedom to use the software for any purpose,
  • the freedom to change the software to suit your needs,
  • the freedom to share the software with your friends and neighbors, and
  • the freedom to share the changes you make.

Command usages

Simple poll

/poll "What's your favourite color ?" "Red" "Green" "Blue" "Yellow"

Anonymous poll

/poll anonymous "What's your favourite color ?" "Red" "Green" "Blue" "Yellow"

Limited choice poll

/poll limit 2 "What's your favourite color ?" "Red" "Green" "Blue" "Yellow"

Hidden poll votes

/poll hidden "What's your favourite color ?" "Red" "Green" "Blue" "Yellow"

Anonymous limited choice poll

/poll anonymous limit 2 "What's your favourite color ?" "Red" "Green" "Blue" "Yellow"

For both question and choices, feel free to use slack's emoji, *bold* ~strike~ _italics_ and `code`

Self hosted installation

Wiki pages are available to help you with the app configuration and the web page configuration.

Known issues

More than 15 options

If you have more than 15 options, you will probably raise an error. It's a slack limitation (see issue #24).

Support me

To support or thank me, you can contact me. I would be happy to provide you my PayPal address.