From 906e116d99d213f874049155fd482d319e138845 Mon Sep 17 00:00:00 2001 From: Nathann Morand Date: Sat, 17 Sep 2022 23:11:22 +0200 Subject: [PATCH 1/3] Added a quick feature overview + screenshot Added a quick feature overview + screenshot --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e6c1c70..76e889c 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,26 @@ Bitpoll is a software to conduct polls about Dates, Times or general Questions. This is a new version of the Dudel from opatut () used on , rewritten using the Django framework as a backend. - -# Using Docker +Poll creation pannel +![image](https://user-images.githubusercontent.com/15912256/190876284-ac6dd2e0-04c6-4d44-a53d-7dd72263a109.png) +![image](https://user-images.githubusercontent.com/15912256/190876419-d129d3c2-cda0-4da6-8b7a-7a30bf5d83e9.png) +![image](https://user-images.githubusercontent.com/15912256/190876455-55d8dc36-a117-4c41-b4ce-5184f5db8bc5.png) +What the user see when choosing a combination +![image](https://user-images.githubusercontent.com/15912256/190876484-a5b3cb2c-db77-4c5f-b1f2-43b5106c4691.png) +and here are the result being displayed +![image](https://user-images.githubusercontent.com/15912256/190876528-178ace35-a3b8-4a55-8bf6-5c5afe0662c9.png) + +# Features + * set if anonymous votes are casted or if the user must provide it's name + * set if registration is required for voting + * allow the creation of private event only accessible to thoses invited + * Poll can be created for full day event or just a few hours. Custom classes can also be defined + * URL can be set manually or randomly choosen + +# Installation +you can deploy this tool on your server either by manually clonning the repo and setting it up or you can run a docker image. + +## Using Docker ~~~ docker build --tag @@ -20,7 +38,7 @@ The Container listens for uwsgi traffic on Port 3008 and for HTTP traffic on Por TODO: add example nginx Config -# Manual Install +## Manual Install Get the code: @@ -50,7 +68,7 @@ Run Testserver: ./manage.py runserver ``` -# Production +## Production In production Senty is used for error reporting. django-auth-ldap is used vor login via ldap @@ -80,7 +98,7 @@ For Production systems it is nessesarry to run ./manage.py collectstatic ``` -# Management of Dependencies +## Management of Dependencies We use pip-tools to manage the dependencies. After modification or the requirements*.in files or for updates of packages run From c83c763389fa901ed6a34b1a73033aeedd02d928 Mon Sep 17 00:00:00 2001 From: Nathann Morand Date: Sat, 17 Sep 2022 23:12:40 +0200 Subject: [PATCH 2/3] added screenshot + features added screenshot + features --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 76e889c..c328775 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,17 @@ Bitpoll is a software to conduct polls about Dates, Times or general Questions. This is a new version of the Dudel from opatut () used on , rewritten using the Django framework as a backend. + + +# Features + * set if anonymous votes are casted or if the user must provide it's name + * set if registration is required for voting + * allow the creation of private event only accessible to thoses invited + * Poll can be created for full day event or just a few hours. Custom classes can also be defined + * URL can be set manually or randomly choosen + +# GUI + Poll creation pannel ![image](https://user-images.githubusercontent.com/15912256/190876284-ac6dd2e0-04c6-4d44-a53d-7dd72263a109.png) ![image](https://user-images.githubusercontent.com/15912256/190876419-d129d3c2-cda0-4da6-8b7a-7a30bf5d83e9.png) @@ -13,13 +24,6 @@ What the user see when choosing a combination and here are the result being displayed ![image](https://user-images.githubusercontent.com/15912256/190876528-178ace35-a3b8-4a55-8bf6-5c5afe0662c9.png) -# Features - * set if anonymous votes are casted or if the user must provide it's name - * set if registration is required for voting - * allow the creation of private event only accessible to thoses invited - * Poll can be created for full day event or just a few hours. Custom classes can also be defined - * URL can be set manually or randomly choosen - # Installation you can deploy this tool on your server either by manually clonning the repo and setting it up or you can run a docker image. From bf3236d5597f033ceda62840570b07a79acec226 Mon Sep 17 00:00:00 2001 From: Nathann Morand Date: Sat, 17 Sep 2022 23:22:14 +0200 Subject: [PATCH 3/3] added link to demo added link to demo --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c328775..9ba1c27 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ This is a new version of the Dudel from opatut (