Skip to content

jericahuang/pchub

 
 

Repository files navigation

Peace Corps Hub

Background

Systers has partnered with Peace Corps to develop several web and mobile applications. We've also created a Mobile App Control Center (MACC) to push notifications and updates from web application to mobile app. All of the applications have separate repos in our Github organization, but we don't have a central hub for Peace Corps staff and volunteers to access all of the applications. The next phase in bringing all of the applications together is the Peace Corps Hub.

Peace Corps apps

Mobile Applications

Malaria Android iOS
PeaceTrack Android iOS
FirstAide Android iOS
RealTrack Android iOS
Mobile App Control Center

Web Applications

Ushahidi
Photo Language Translation FirstAide PC Prep Kit

Installation Guide

1. Installing Ruby

There are several options to install Ruby, this tutorial will use the installation from source, but you can see tutorials of others options on the Ruby page.

To install from source download and unpack this package. Then do:

$ ./configure
$ make
$ sudo make install

By default, this will install Ruby into /usr/local. To change, pass the --prefix=DIR option to the ./configure script.

2. Installing SQLite

Today, almost all the flavours of Linux OS and latest version of Mac OS X are being shipped with SQLite. So you just issue the following command to check if you already have SQLite installed on your machine or not.

$ sqlite3 --version

If you don't have SQLite installed, follow the steps below:

Download this package.

Then do:

$ tar xvfz sqlite-autoconf-3071502.tar.gz
$ cd sqlite-autoconf-3071502
$ ./configure --prefix=/usr/local
$ make
$ make install

3. Installing Rails

To install Rails, use the gem install command provided by RubyGems:

$ gem install rails

To verify that you have everything installed correctly, you should be able to run the following:

$ rails --version

4. Installing Dependencies

ImageMagick is a dependency for this project. If you don't have it installed, install it by following the steps here:

https://www.imagemagick.org/script/download.php

5. Setting environment variables

Set environment variables such as account settings and API keys in pc-hub/config/local_env.yml. The file is gitignored, so private information will not be checked in.

Running the App

Download or clone the app to your desktop. cd into the pchub/pc-hub directory:

$ cd path_to_downloaded_pchub_repo/pc-hub

Install the gems by running:

$ bundle install

Set up the database by running:

$ rake db:setup

Launch the app server by running:

$ rails server

Navigate to localhost:3000 on your web browser.

Update the gems to their latest versions, if needed, by running:

$ bundle update

Running tests

To run tests, run the following command:

$ rake test

Project History and Goals

This project was started in the Qualcomm EmpowHERment Hackathon. The goal during the hackathon was to create a web application that will be the Peace Corps app hub. The hub should have login access and also include access to all of our Peace Corps web and mobile app projects. It was specified that it must be implemented in an open source language in order to align with the open government initiative of the Peace Corps.

Deliverables from the Hackathon

PCHub Winners site (initial design)
PCHub Detail Design Documentation
PCHub Demo site

After the Hackathon

PC Hub has been in the continuing works by independent contributors, as well as Open Source Day and Google Summer of Code. We invite you to contribute. You can submit a PR for your work against the “develop” branch on Systers PCHub GitHub repo.

PC Hub has been a project in Systers Google Summer of Code throughout the years. Please visit the GSoC wiki for each year so that you can see what the students have worked on. This will bring you up-to-date on the current state of the project.

GSOC 2014

GSoC 2016

GSoC 2018

Requirements for the Project

User Interface/User Experience

  1. Must have a clean look, aesthetically pleasing to the eye.

  2. Must be easy to navigate.

  3. Must be able to access and view on mobile device, tablets/iPad and Web browser on desktop/laptop.

Feature Requirements

  1. Must have login.

Users can be - Administrators (Level 3, all access to everything, configuration, logins, etc.) - PC Staff (Level 2, Does not have access to administrative tasks, adding a PC volunteer) - PC Volunteers (Level 3, Access to all applications)

  1. Must have simple listing or buttons to access all of the Peace Corps web and mobile applications.

  2. Notification area where administrators can add important information about updates to the applications or just general information

  3. Forum area would be a nice to have a forum feed similar to Facebook/Twitter/Google+ for people to - Start a discussion/topic - Comment on those discussions/topics - Chat feature where people can chat with other PC staff/volunteers who are LOGGED IN (Nice to have)

About

This project has been archived until AnitaB.org finds new contacts within Peace Corps to finish and test these projects in the field.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 38.5%
  • HTML 37.7%
  • Ruby 20.1%
  • Java 3.2%
  • Other 0.5%