Files
abot/README.md
2018-12-12 22:09:12 +02:00

37 lines
1.2 KiB
Markdown

# aBot engine
- Make voting questions in simple text files
- single choice, multiple choice and open text questions supported
- read more from example questions sets
- Preview form online
- Get tokens for voting in command line
- Send unique URLs to your voters (mailing example script included)
- Summarize results in the command line
- Online part runs with python3 + flask + gunicorn
- Command line tools python3
## Basic usage instructions
- Install requirements `./install.me`
- Start server `./start.me`
- Create questions in `questions/my_poll.txt`
- Have `draft: true` in the questions, and view the poll at
[preview](http://localhost:8041/preview/my_poll)
- Change to `draft: false` to enable voting
- Add tokens for the vote:
`./manager token --prefix http://localhost:8041 my_poll`
- Open the link to vote
- Get summary of votes: `./manager summary my_poll`
## Additional usage
During the poll, you can observe the vote counts:
- Add an observer token:
`./manager token --prefix http://localhost:8041 --role observer my_poll`
- Open the link to see vote counts
- If the question se allows voters to see results after casting their vote
`show_results: true`, then observer can also see the results.