adeelcheema / berkeley-rishi

This repository holds the code for UC Berkeley Project Rishi's website. Please see the README for more information.

Project Rishi x CS 169

Project Statistics

Pivotal Tracker

Project Rishi Pivotal Tracker

Heroku

https://berkeley-rishi.herokuapp.com/

Customer's Business Need:

This app will serve as the homepage of Project Rishi's Berkeley chapter. The goal is to have the page showcase the work that has been done over the years in their deployment in India for the general public to see. They would also like an internal method that would allow Project Rishi members to update each other on their progress in preparation for their annual trip to india.

Update (October 2017):

The customer's business needs changed as they decided that their priority is the homepage map. The homepage map should be customizable and dynamic, allowing for more landmarks to be added and any user to customize their own map experience, such as with filtering of landmarks and filtering.

More information about Project Rishi can be found here:

http://www.projectrishi.org/ https://www.facebook.com/ucbprojectrishi/

Deployment Notes

Project Rishi's site is built using Ruby on Rails. All needed packages are located in the Gemfile.

Clone all repo files and run bundle install --without production and rake db:setup on your local machine.

In order to use the Google Maps API and the Google Authentication API securely, we use Figaro to manage authentication keys.

Figaro

Google API Documentation

In the root project directory, create an application.yml file. You will need to define the following variables

google_api_key: #GoogleMapsApiKey

google_client_id: #OAuth2.0 Client ID

google_client_secret: #Oauth2.0 Client Secret

In order to access the internal sign in pages, please add your email to the UserList table within the seeds file.

Project Authors

This project was created in Fall 2017 under advising of UC Berkeley's CS 169: GSI Ben Mehne and Professor Armando Fox.

Adeel Cheema, Pranav Harikrishnan, Chittaranjan Prasad, Nan Jiang, Niraj Rao