A collaborative open source infrastructure for running web-based patient-powered research networks (PPRNs)
Ruby CSS CoffeeScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.profile.d
app
bin
config
db
lib
public
test
vendor/assets
.gitignore
.ruby-version
.simplecov
.travis.yml
CHANGELOG.md
Gemfile
Gemfile.lock
LICENSE.md
PREREQUISITES.md
README.md
Rakefile
changelist
config.ru

README.md

OpenPPRN

Build Status Dependency Status Code Climate

A collaboration to build an open-source solution for creating patient-powered research networks.

Before Starting Installation

Make sure you have reviewed and installed any prerequisites.

Installation

gem install bundler

This README assumes the following installation directory: /var/www/opn

cd /var/www

git clone https://github.com/openpprn/opn.git

cd opn

bundle install

Install default configuration files for database connection, email server connection, server url, and application name.

ruby lib/initial_setup.rb

bundle exec rake db:migrate RAILS_ENV=production

bundle exec rake assets:precompile RAILS_ENV=production

To set up your secret keys, run

figaro install

Add the following lines to the /config/application.yml file it generates and modify them accordingly. Add the appropriate keys you've gotten from the third party developers. For any service you aren't using, you can leave the lines out:

pprn: "ccfa"
pprn_title: "CCFA Partners"
pprn_condition: "Crohn's & Ulcerative Colitis"
pprn_conditions: "Crohn's, Ulcerative Colitis"
pprn_support_email: "support@ccfapartners.org"

oodt_enabled: "true"
validic_enabled: "true"

uservoice_api_key: 
google_analytics_web_property_id:

validic_access_token: 
validic_organization_id: 

oodt_username: 
oodt_password: 

Open PPRN.rb to

  • Configure the basic information about your PPRN
  • Enable or Disable Validic and OODT

Run Rails Server (or use Apache or nginx)

rails s

Open a browser and go to: http://localhost:3000

All done!

Deploying to Heroku

If you are deploying to heroku, to get your application.yml loaded into heroku environment configuration (required to function), do

figaro heroku:set -e production

Seeding your Database

If you are just doing test installs or demonstrations of the website, you may want to start with some seed data. Some combination and/or all of these below should get you started:

rake db:seed
rake surveys
rake legacy_seed

Modification of Content & Layout

The main navigation of the application is structured like so (in controller#action/view_name format):

  • Home#Index
  • Research#Index
  • HealthData#Index
  • Members#Index

If you want to edit any of the major views, you'll find them in the app/views/home, app/views/research, app/views/health_data, & app/views/members directories in .html.haml formats (eg. app/views/home/index.html.haml is the logged-in home page)

Each of those directories contains related partials that are used to help support the views, named with a leading underscore, eg. _tutorial.html.haml, which is the tutorial accessible by tab on most of the major views.

The logged out homepage is Static#Splash (can be found in app/views/static/splash.html.haml). Other static (about/tos/pp) and content pages (lots of text about the network) can be found in this same directory.