Skip to content

Latest commit

 

History

History
169 lines (120 loc) · 5.02 KB

README.md

File metadata and controls

169 lines (120 loc) · 5.02 KB
Raw

Women Rising

Build Status

Women supporting women in tech and business.

Women Rising is a website that helps to permote women by assisting them in finding female peers and mentors in their field.

The website for women rising has become an open source project. Our goal in making this open source is to give mainly women but anyone who is looking to get into development or someone who is just looking for a project to help out with, a place to display their awesome skills as well as try to give feedback to people on their code. All this is to be done in a respectable way, any contributor should review our code of conduct at Code Of Conduct. If you have any complaint please let us know by sending an email to [email protected] and we will do our best to address them!

Getting Started

In order to get started with this project please fork the repo and clone it to have it locally on your computer.

Setting up with Linkedin:

Create your own application on linkedin developer site on this page click my Apps which will take you to a create an account screen. If you already have a linkedin account look to the bottom to find a sign in with linkedin.

This personal application will allow you to create a testing enviroment which will allow you to login as yourself and view changes to your profile.

Next create an application on Linkedin

Fill in the information with temporary info using your personal email and phone for business. The application use will be networking and you can use the womenrising logo and url for the logo and url and click submit after agreeing to the terms.

Under Authentication, you will find your client ID and Secret (keep these secret!!). You will also see Default Applications persissionsi under that check off r_basicprofile r_emailaddress and w_messages (you will need those for the profile).

Next under OAuth 2.0 add in the redirect URL for http://localhost:3000/users/auth/linkedin/callback and https://localhost:3000/users/auth/linkedin/callback (this will allow linkedin to redirect back to your localhost also if your localhost is something other than 3000 you just need to change the number to the correct one).

Setting up With Oauth2.0

In your config folder create an application.yml file (this file should contain the appid and secret key that you created). Once you have done that go into the file and add:

LINKEDIN_ID: <<your Client ID here>>
LINKEDIN_SECRET: <<your Client Secret here>>

gmail_username: <<your gmail email address>>
gmail_password: <<your gmail password>>

note this file is in the .gitignore file so it will not be uploaded to the internet (hence why we are having you create the linkedin dev account). The use of the gmail username and password is only for sending emails and will not be seen by anyone else.

This will give you access to Linkedin so that you will be able to sign-in.

Development Environment

Mac OSX

  1. Install homebrew. See instructions on their website, http://brew.sh/.

  2. Install postgres.

brew install postgresql

  1. Install rvm. See intructions on their website, https://rvm.io/.

  2. Use rvm to install the current ruby version.

rvm install ruby-2.3.0
  1. Install bundler.
gem install bundler
  1. Clone the repo and cd (change directory) into the womenrising rails app and install the gems.
git clone [email protected]:womenrising/womenrising.git
bundle install
  1. Set up the database:
rake db:create
rake db:migrate
rake db:seed  # seed file containing test users
  1. Fire up the app, and open your web browser to localhost:3000.
rails server

Docker

  1. Install docker-machine locally

  2. Start docker-machine,

docker-machine start default
docker-machine env default
  1. Run these commands,
docker-compose build
docker-compose run web rake db:create db:migrate
docker-compose up

Importing the Staging or Production DB

pg_restore --verbose --clean --no-acl --no-owner -h localhost -d womenrising_development ./db/backup-2016-01-14.dump

Reporting Bugs

Currently the how to report bugs is being worked on. If you have any issues please send it to [email protected].

Please make sure that you have your issues be as detailed as possible (screenshots are always helpful!!).

Sources

The choice of the code of conduct was inspired by the awesome Coraline Ada Ehmke from her talk at Geekfest. If you want to look more into this you can find more at contributor-covenant.

Monthly Matches

# open a heroku rails shell
heorku run rake womenrising:peer_group_monthly_match c -a womenrising