Berkeley PBL Members Portal V2

This repo contains code for PBL Links, Blog, Tabling generator, Points, etc

see the documentation folder for guides

Description of features

PBL Links: custom url shortener and internal search engine. Ideally any PBL Resource will be findable via PBL Links, allowing members to simply remember what they're looking for and not how to find it. Uses Groups for access control.

Groups: groups are the means of access control for PBL Links and the blog. Add emails to groups (ex: Fall 2014 Officers: davidbliu@gmail.com, etc...), then set Links or Posts to belong to one or more groups. If you belong to any of the groups the link or post belongs to, you can view it.

Blog: a collection of posts. PBL uses its blog like a bulletin board of recent/upcoming events and announcements

Tabling: generates a tabling slot for each member each week. Algorithm tries to place officer in each slot (with special emphasis for first and last slot of day). uses commitments to avoid time conflicts.

Points: points are awarded for attending events. Events have points (pbl.link/points-sheet) and members mark if they attended or did not attend events.

Pusher/BlogMailer: sends out two types of notifications: push notifications and emails. Currently both types are sent out for blogposts only...

Chrome Extension: allows easy creation of PBL Links. also sets the groundwork for receiving push notifications. repo here: pbl.link/extension-git

Getting set up to develop

if you're using linux, theres a tutorial for ubuntu setup (prod.md) in the documentation folder of this repo

if using mac, here are steps. if using windows, ggrip

1) Install rvm

2) Install postgres

3) Install elasticsearch

4) Clone repo

5) setenv.sh

6) finishing touches

7) run rails s

Understanding models

these are the models/files you should look at for each of the corresponding feature on the portal. Listed as feature: models

Pablo (IGNORE THESE): Boba, BotMember, DefaultMessage, FBMessage, Pokemon, Pablo, Topic

PBL Links: GoLink, GoLinkClick, GoLinkGroup, Group, GroupMember

Blog: Post, Group, GroupMember

Groups: Group, and associated models

Tabling: TablingSlot, TablingSwitchRequest, TablingManager

Points: Event, Member

Misc: Member, Semester, Position

PBL Links

The main models involved are GoLink, Group, GoLinkGroup, GroupMember, and GoLinkClick

GoLinks have key, url, description, member_email

GoLinks belong to Groups through the join table GoLinkGroup

Groups have many GroupMembers, and a GroupMember is just an email that belongs to some group_id

GoLink

fields: key, url, description, member_email, is_deleted

is_deleted is used for undo-ing deletion of links. The first time a user deletes a link, we set the link's is_deleted flag to true but dont actually delete the link from the DB. When the user confirms that he/she wants the link gone, we delete the link from the db.

notice that the default_scope filters out the is_deleted golinks.

GoLink.all # by default returns links with is_deleted = false

GoLink.unscoped.all # returns all golinks, even deleted

GoLink.unscoped.deleted # returns all deleted golinks

Group

main thing is Group.groups_by_email, which returns groups that this email is a part of. example Group.groups_by_email('davidbliu@gmail.com') #=> [group1, group2]

Reading list and related projects

Chrome extension: pbl.link/extension-git, pbl.link/extension

Oauth

Elasticsearch

Contact

David Liu: davidbliu@gmail.com