Skip to content

Commit 6e6a82b

Browse files
committed
Documentation update with README.md, includes license and screenshots
1 parent b1d866e commit 6e6a82b

8 files changed

Lines changed: 219 additions & 1 deletion

LICENSE.md

Lines changed: 164 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
1-
live-poller
1+
# Live-Poller
2+
3+
## Author
4+
5+
Weidi Zhang
6+
7+
## License
8+
9+
[Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International](LICENSE.md)
10+
11+
## Description
12+
13+
Live Poller is a platform created with Flask that allows for quick and efficient polling, designed specifically for use in a live setting where many people are gathered together at one place.
14+
15+
## Features
16+
17+
* Management panel for all polls: create, delete, close, share, and view results
18+
* Specify which IP addresses can manage polls; by default this is set to localhost (127.0.0.1)
19+
* Highly customizable: poll question/text, add an unlimited number of possible responses, choose the closing time of the poll
20+
* Share a poll with a page that displays a QR code that can be quickly scanned by mobile users
21+
* Simplicity in voting - no extra bloat on any page
22+
* Session checking to avoid repeat voters on a poll
23+
* Visual results for all poll results, with all information (e.g. number of votes, percentage) placed on top of the result bars
24+
* Results page automatically updates - no need for manual refresh
25+
26+
## Screenshots
27+
28+
* [Manage Page](doc/images/screenshot-manage.png)
29+
* [Manage Page: Poll Creation](doc/images/screenshot-manage-create.png)
30+
* [Share Page](doc/images/screenshot-share.png)
31+
* [Vote Page](doc/images/screenshot-vote.png)
32+
* [Results Page](doc/images/screenshot-results.png)
33+
* [Results Page (2)](doc/images/screenshot-results-2.png)
34+
35+
## Libraries/Packages Used
36+
* [Bootstrap](https://getbootstrap.com/)
37+
* [Flask](http://flask.pocoo.org/)
38+
* [Flask-QRCode](https://marcoagner.github.io/Flask-QRcode/)
39+
* [flatpickr](https://flatpickr.js.org/)
40+
* [jQuery](https://jquery.com/)
41+
* [sqlite3](https://docs.python.org/3/library/sqlite3.html)
42+
43+
## Requirements
44+
* Python 3.6+
45+
46+
## Installing Required Python Packages
47+
```
48+
pip install Flask
49+
pip install flask-qrcode
50+
```
51+
52+
## Running Live-Poller
53+
54+
1. Edit ```config.py``` as needed.
55+
2. Use the provided ```run.bat``` (Windows) or ```run.sh``` (Mac / Linux) scripts.
81.1 KB
Loading

doc/images/screenshot-manage.png

64.4 KB
Loading
34.5 KB
Loading

doc/images/screenshot-results.png

28.6 KB
Loading

doc/images/screenshot-share.png

29.1 KB
Loading

doc/images/screenshot-vote.png

20.9 KB
Loading

0 commit comments

Comments
 (0)