/landshark

Code for text message reminders

Primary LanguageRuby

Build Status

LandShark

A text message reminder system for San Francisco Human Services Agency.

Contribute

This project is young and in flux. Feel free to email sf@codeforamerica.org if you're interested in deploying or contributing.

Install

  1. Install Rails and Bundler if you don't already have them
gem install rails
gem install bundler
  1. Install PostgreSQL
  1. Clone this repo
git clone https://github.com/codeforamerica/landshark.git
  1. Install required gems
cd landshark
bundle install
  1. Setup environment variables
  • Edit .sample_env by replacing with your Postgres username ($USER by default)
  • Rename .sample_env to .env

LandShark requires four env vars: RACK_ENV, TWILIO_NUMBER, TWILIO_SID, and TWILIO_TOKEN. The easiest way is to use foreman and a .env file in the root directory, but there are many ways to do this. Heroku has a good overview here.

Make sure your .gitignore always includes /.env so you don't publicize your secret keys.

  1. Setup local database
  • First, edit config/database.yml to include your Postgres username ($USER by default):
development:
    adapter: postgresql
    host: localhost
    username: <username>
    database: landshark
  • Then run:
rake db:create
rake db:migrate
  1. Start the server
foreman start
  1. You should see the project at http://localhost:5000

codeforamerica