Office Hours Queue

Overview

Provides a web-based interface for requesting help during office hours.

Students request help on an assignment and question number from a location.

This app uses Ok to manage access. Even if you aren't using Ok for assignments, you should create a course on Ok and enroll all of your staff, academic interns, and students with the appropriate roles.

Installation

1. Clone this repo:

   git clone https://github.com/Cal-CS-61A-Staff/oh-queue.git
   

   Then cd into it:

   cd oh-queue
   

2. Create and activate a virtualenv:

   python3 -m virtualenv env  (If this does not work, try: `virtualenv -p python3 env`)
   source env/bin/activate
   

3. Use pip to install all the dependencies:

   pip install -r requirements.txt
   npm install
   

4. Reset the database to create tables.

   ./manage.py resetdb
   

   If you get the error "TypeError: OAuthRemoteApp requires consumer key and secret", you need to set your OK_KEY and OK_SECRET environment variables.

5. Run the server:

   ./manage.py server
   

6. Point your browser to http://localhost:5000. (This might take a while the first time.)

7. You can log in as any email while testing by going to http://localhost:5000/testing-login/.

Deployment

First point a git remote to the Dokku server:

git remote add dokku dokku@<server>:officehours-web

To deploy from master:

git push dokku master

Deploy from another branch:

git push dokku my_branch:master

First Time Deployment

dokku apps:create app-name
git remote add online dokku@<server>:app-name
dokku mysql:create db-name
dokku mysql:link db-name app-name
# Set DNS record
dokku domains:set app-name <domain>

dokku config:set app-name OH_QUEUE_ENV=prod OK_KEY=<OK CLIENT> OK_SECRET=<OK SECRET> SECRET_KEY=<DB SECRET> COURSE_NAME="CS 61A" COURSE_OFFERING="cal/cs61a/fa16"
dokku run app-name python
>>> from oh_queue import app
>>> from oh_queue.models import db
>>> db.create_all(app=app)
>>> exit()
dokku letsencrypt app-name
# Change OK OAuth to support the domain

For OK_KEY and OK_SECRET, you'll need to create an Ok OAuth client here and have it approved by an Ok admin.

Configuration

The following env variables can be set to customize the app:

• COURSE_NAME - Name of course as displayed in the app
• LOCATIONS - Comma-separated list of locations students can request help from
• ASSIGNMENTS - Comma-separate list of assignments students can request help on