staff and event management, with Google calendar sync
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
piipod
tests
.gitignore
LICENSE
Procfile
README.md
makefile
manage.sh
migrate.py
requirements.txt
run.py
runtime.txt
sampleconfigvars.py

README.md

Piipod

Staff and event management, with Google calendar sync and a one-click Google sign in; used at TEDxBerkeley to manage 230 volunteers, now being used to manage ~150 staff members across 2 courses - CS61B, CS70 - at UC Berkeley.

created by Alvin Wan, Spring 2016

To get started, see piipod.com

Features

Google Login One-click login and registration for ease-of-use

Staff Approval Add staff emails to the whitelist to auto-promote staff.

Google Calendar Sync One-click synchronization to load events from Google calendar.

Automatic Waitlist Resolution:

  • Constraint Satisifaction Problem Model allows staff to setup event signup minimum or maximum, per-user signups maximum or minimum for a group of events.
  • Stable Marriage Algorithm allows staff to accept waitlisted users based on user preferences.

Batch Processing and Filtering Allows you to auto-categorize signups, process multiple events at once, and/or filter by signup properties. Categories can be shifts, tasks, or anything else representable with a string.

Installation

These instructions assume the mySQL server has been started. See MySQL below.

Dependencies

Check that Python3 and MySQL are installed using make check.

Getting Started

  1. Run the installation using make install.
  • Optionally, use make install CONDA=false instead, to use virtualenv.
  1. Add valid mysql user credentials to configvars.py.
  2. Create the database using make db.

If the bash scripts do not work, see the Details section below for an outline of what each script does.

During development, you may additionally want to remember the following:

  • In the future, use source manage.sh activate to activate the virtual environment. If installed without Anaconda, use source manage.sh activate CONDA=false
  • Any model modifications, in the development environment, should be followed by make refresh, which will delete the old database and replace it with a new one.

Unix and Mac OSX Details

In case the installation script fails, you may execute the contents of the installation bash script line by line:

  1. Setup a new virtual environment: conda create -n piipod python=3.4.
  2. Start the virtual environment: source activate piipod.
  3. Install all requirements: pip install -r requirements.txt.
  4. Make a new configuration file: cp sampleconfigvars.py configvars.py.
  5. Add valid MySQL user credentials to configvars.py.
  6. Create the database: python3 run.py -db create'.

Any model modifications should be followed by the following, which will delete the old database and replace it with a new one: python3 run.py -db refresh

Windows Details

Because of incompatbility issues with the makefile, on Windows you will have to manually run the installation instructions.

  1. Setup a new virtual environment by calling python -m virtualenv env.
  2. Start the virtual environment by calling env/Scripts/activate.bat in cmd.
  3. Install all requirements pip install -r requirements.txt.
  4. Make a new configuration file: cp sampleconfigvars.py configvars.py.
  5. Add valid MySQL user credentials to configvars.py.
  6. Start the MySQL service using services.msc
  7. Create the database by using mysql -u root -p, then entering create database queue; in the interactive prompt.
  8. Setup the database using python3 run.py -db create.

Launch

Use make run.

If the bash script does not work, see the Details section below for an outline of make run.

Unix and Mac OSX Details

  1. Start the virtual environment: source env/bin/activate.
  2. Launch server: python3 run.py.

Windows Details

  1. Start the virtual environment by calling env/Scripts/activate.bat in cmd.
  2. Launch server: python run.py.

MySQL

  • For Mac OSX installations of MySQL, via Brew, start the server using mysql.server start. For other Linux-based operating systems, use sudo service mysql start.
  • For Windows, just start the server using services.msc.