bwanicur / duwara_volunteer Goto Github PK

This document will outline the high level arch decisions (not set in stone) and objects that we will need to create this application. Simply put, it is a way for Volunteers to sign up for events that Duawara Org has organized.

Objects

User

• different roles:
  • Admin
  • Organizer (can create / manage events)
  • Volunteer (base role)
• email / password required for auth / reg
• phone highly encouraged, but not required
• attributes include the typical atts but also age
  • we need to the age so we can exclude minors from some events
• has_many events

Event

• Location (address)
• start_time (end_time is optional)
• google map or other link
• contact info
• has_many volunteers

Event Invitation

• joins the Event to volunteers
• also contains the state of the invitation (yes, no, pending, waiting_list)
• has unique invite hash value used for URL invitations
• will hook into email (and maybe SMS) notifications / reminders
• belongs_to event
• belongs_to user (volunteer)

Location

• address
• google map or other link
• this object is NOT related to events. it only exists to make pre-populating the event address fields easier for the users

Tags

• used to tag events / volunteers
  • can be used to exclude / include volunteers on certain events

More objects are coming. This is just the start / main objects.

The Plan

We will create issues for each feature and/or page of the application. The details for implementation will be detailed in each issue. I am a firm believer in early PRs. By that, I mean open your PR very early in the process and include "WIP" in the title. This gives us a chance to discuss the high level details of the code early on and formulate a approach. Hopefully we can end up with a fairly uniform codebase.