Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Home

Jump to bottom
Mark Ignacio edited this page Aug 22, 2016 · 2 revisions

What's ppl?

ppl is a read-only webapp that gives some Hack@UCF ops and selected third parties a way to:

  1. Search and view official membership status in the RSO (some ops only)
  2. Subscribe new members to the mailing list unless they already unsubscribed
  3. Share resumes submitted by members to sponsors, speakers, and selected third parties (admins, execs, and relevant parties only)
  4. Support resume exporting and sorting (admins, execs, and relevant parties only)
  5. Integrate the above with Google Drive and SSO

ppl is read-only in the sense that it can't be used to directly create, update, or delete members or resumes seen through the app.

Installation

Please read How it Works to avoid time-consuming gotchas.

First, copy the settings template file:

$ cp ppl/local_settings.template.py ppl/local_settings.py

Go to the Google API Console and provision two sets of API credentials:

  1. An OAuth web application with Google Drive API access (for user login). Copy the key and secfret into SOCIAL_AUTH_GOOGLE_OAUTH2_KEY and SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET in ppl/local_settings.py.
  2. An "other" application for server-side updates via the management console. Export these credentials as JSON to client_secrets.json.

Change these to their appropriate values:

  • ALLOWED_HOSTS
  • ADMINS - Please don't spam me with Django error emails.
  • DATABASES - The defaults are fine if you're not deploying with Docker.
  • GOOGLE_MEMBERSHIP_FILE_ID
  • GOOGLE_RESUME_RESPONSES_FILE_ID

Optionally, change SECRET_KEY to a good persistent value so that users do not have to re-login after every restart.

Install with Docker

Proceed to the instructions at ppl.docker.

Install without Docker

Assuming you've set up a Django application before, the only new thing to you should be ppl/local_settings.py - this file overrides anything in ppl/settings.py.

Proceed with a whatever WSGI and static file server you prefer!

Maintenance

Some common tasks are covered in the Maintenance Guide.

Clone this wiki locally