Skip to content

PerlmutterFellows/PerlmutterApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Perlmutter App

Perlmutter App

An application developed to help not for profits maintain communication with constituents in the post-pandemic environment.

Organizations can send events, information, and messages as admins to users via call, text, email, or in-app newsletter, whichever contact method(s) each constituent has access to or would want to use.

Organizations can download this repository and run the organization initializer to configure their app and deploy a customized app for their organization's needs.

Our initial client in developing the app is The Haven Project, an impactful organization started to address a gap in services to unaccompanied homeless young adults and surrounding communities. They provide direct service to more than 200 homeless unaccompanied youth ages 17-24 each year in their Drop-in Centers, with referrals to other youth serving organizations for hundreds more who don’t meet intake criteria.

Hosting Services/Costs

The Perlmutter App relies on a few services to function, which may incur costs. It is hosted on Heroku and it uses Twilio to provision and automate a phone number to call/text users from. You must provide a payment method to each of these services to use the Perlmutter App.

Heroku is free by default, but can upgrade your app's performance with increased tiers.

Twilio costs, according to their pricing in August 2020, $1.00/month for the phone number powering the app, $0.0085/min to receive and $0.013/min to make calls, and $0.0075 to receive and make texts.

These services are all provisioned via the initializer with your user input, to help simplify the process for you!

Initialization

Installation/run instructions:

  1. Install Git (use the page's navigation to pick your operating system)
  2. Install Ruby
  3. Download or clone this repository
  4. In the project folder, run the following commands
    • gem update --system
    • bundle install
    • ruby org_init.rb

Organization initializer instructions (required steps in bold, all credentials requested will be prompted to create new/sign up for if you don't have):

  1. Provide your organization's name & description
  2. Provide your organization's preferred website for the app
  3. Provide your organization's colors
  4. Provide your organization's logo or use one of our presets
  5. Provide your organization's email credentials to power the app's email capabilities
  6. Provide your Twilio credentials to power the app's phone capabilities
  7. Create an FAQ for your organization
  8. Create a score form for your organization
  9. Provide details to set your organization's admin user login for the app
  10. Provide your Heroku credentials to deploy the app

Development

Want to develop the Perlmutter App?

  1. Install Git (use the page's navigation to pick your operating system)
  2. Download or clone this repository
  3. Install Ruby on Rails (use the page's navigation to pick your operating system)
  4. In the project folder, run the following commands
    • gem update --system
    • bundle install
    • yarn install --check-files
    • npm install
    • rake webpacker:compile
    • rake db:create
    • rake db:migrate
    • rails dev:cache - (Toggles caching on/off, run until it is being cached)
  5. If running in development, install ngrok (Link here, or brew cask install ngrok on OSX with Homebrew) for receiving calls/texts when running on your local environment

Team

Developers

Mitchell Dodell

Adam Fleishaker

Project Manager

Daniel Khudyak

Advisors

Prof. Gene Miller

Prof. Ian Roy

Special Thanks

Louis and Barbara Perlmutter

Beth Marshdoyle

The Haven Project

Twemoji

Workflow

To better understand our workflow and progression, please install the Zenhub extension and look at our Zenhub project board for this repository.