/medlink

A project to make it easier for Peace Corps volunteers to get their medical supplies, started as a Random Hack of Kindness

Primary LanguageRubyOtherNOASSERTION

Code Climate Build Status Coverage Status Ready Stories

PC Medlink - Peace Corps Medical Supplies

This project grew out of a National Day of Civic Hacking. You can see a live version of the site at pcmedlink.org.

Developing locally

If you have any questions at all, feel free to email James or post on the Google Group.

To get started with a local copy of the project, run

$ git clone git@github.com:atlrug-rhok/medlink.git
$ bundle
$ rake db:setup

Optional admin setup. Make sure git is configured globally as this becomes your admin username.

$ rake admin:create

and you should be off to the races. You can check your setup by running the specs with

$ rake spec

If it's green, you should be good to go.

Then create a pull request and we will review it and merge it into the repo. We also use Travis for Continuous Integration and Relishapp to host Cucumber specs.

Cucumber (Acceptance Tests)

  • To run the cucumber tests, just go to the top project directory and type cucumber.
  • To run the cucumber javascript tests, just go to the top project directory and type cucumber -p javascript. These tests must be run with the GUI; the other cucumber tests do not have this requirement. If you on a Mac, please this article to install chromebrowser.

If you want to run both specs and cucumber tests with

$ rake

Twilio (SMS integration)

A few components require a little extra setup to run:

You'll need to sign up for Twilio and set the TWILIO_ACCOUNT_SID, TWILIO_AUTH and TWILIO_PHONE_NUMBER environment variables. If you'd like to receive SMS messages to your local machine, you can set up localtunnel and run

$ localtunnel 3000  # Assuming your development server is running on port 3000

and point your Twilio request URL at the address it specifies (http://something.localtunnel.com).

BUGS

If you get a problem with the software?

Please create an email describing the steps to reproduce the software problem and email it to support mailing list. You will receive an acknowledgement and initial assessment without 24 hours.

If you would like to see the #TODO's/#FIXME's/etc, then run "./bin/chk" or "./bin/chk more" bash scripts from the top project directory.

Contributors

Special thanks to the consulting Peace Corp members, without whom none of this would be possible:

  • Patrick Choquette
  • Caitlyn Bauer
  • Jeffrey Rhodes
  • Danel Trisi
  • Kevin Sun
  • Chenheli Hua

Additional thanks to the RHoK team for their outstanding work getting this project off the ground:

  • John Craft
  • Jack Craft
  • James Dabbs
  • Diane Deseta
  • Kate Godwin
  • Jonathan Howard
  • Clint Lee
  • Gordon Macie
  • Emily Merwin
  • Laura Moore
  • Chae O'Keefe
  • Drew Pak
  • Gerry Pass
  • John Petitte
  • Luke J Reimer
  • Al Snow
  • Patrick Stoica
  • Jake Swanson
  • Nate Tate

We welcome other contributions - just open up an issue or a pull request.