Zwennsch / schaumburg-votes

Python webapp with Flask collecting votes in a school - Schaumburg-Votes

A fully functional webapp written in Python using the Flask framework to collect and evaluate votes from students.

Students from Schaumburger Str. Bremen should be able to vote from a choice of courses their favorite three courses.

User instructions:

• initialize the database first from command-line in root folder using: flask --app voting init-db

• load data into database and courses:
  Keep in mind that when in production the instance folder is located in 'venv/var/voting-instance' instead of the regular instance folder of a flask app.

  1. store a file students.csv in the instance folder.
     This will only be for temporarily use, you can delete this file after the data is stored in the database voting.sql in the instance folder the file contains 4 columns: Klasse, Nachname, Vorname, LogIn

  2. create a courses.csv in the instance folder. It should contain 6 columns: classes, name, max_participants, teacher, description, img_name e.g.
     "8,9,10",football,18,Smith,"Playing football on our local court in school",football.jpg.
     For each course you can place an image in the static folder. If you don't provide one, a default image will be shown later

  3. from command-line in root folder use:
     flask --app voting init-data

     • this leads to two things:
       1. It will create a new file in instance folder called 'student_pwd.csv' which contains the original students.csv info and an additional column containing a 5 letter password for each user. These passwords should be passed individually to each student for login. You can delete this file afterwards.
       2. the user table in voting.sqlite gets filled with users and hashed passwords

• create admin-user for access to voting progress.
  from command-line in root folder use:
  flask --app voting create-admin [username] [password]
  the [username] argument mustn't been taken by any other user. This will be checked and leads to an error otherwise. the [password] argument must be at least 5 characters long

• run the app with:
  flask --app voting run

Student uses the app:

• see all available courses to choose from:

• log in:

• pass a vote:

Admin uses the app:

• After logging in as admin user you are able to add/delete a student. You can also get an overview of all voting results per class or per course:

• you can calculate a proposal for composition of all the courses and see the results: