Here are some requirements and guides to contributing to the Girl Develop It website code base. Be sure to review this when trying to install a local development environment! Be sure to reach out to us at firstname.lastname@example.org with questions.
Vagrant installation instructions
Using Vagrant is the suggested way to do development for the website. It provides a standard environment that works across platforms.
1. Install VirtualBox
VirtualBox is a cross-platform virtualization application (see: the VirtualBox manual). That means it can install multiple virtual machines at the same time, which is great for development. You can download the latest version on the VirtualBox website.
2. Install Vagrant
Vagrant is a wonderful tool to help you build complete development environments. Download the latest version on the Vagrant website.
3. Clone the gdi-website Git repository
Clone the Git repository into your local development folder:
git clone email@example.com:girldevelopit/gdi-website.git cd gdi-website
4. Start Vagrant
Depending on your machine, this could take a while. Once it's started, you'll ssh into the Vagrant box and run later commands from that environment.
vagrant up vagrant ssh
5. Install and initialize the development environment
Run the following:
cd /opt/gdi/development bundle install rake db:create db:migrate db:seed rails server --binding=0.0.0.0
6. View website
Test your connection in a browser: http://localhost:3000/
MacOS installation instructions
Before you begin
There are a few programs you have to have installed on your local machine before download the Girl Develop It code base.
- homebrew, a package manager for Mac OS X.
- rvm, a command-line tool to manage different versions of Ruby.
- ruby 2.1.7
- PostgreSQL 9.3.+
- Install with homebrew using
brew install postgresand follow the brew instructions for these with
- Using Postgres.app for Mac OS X (recommended).
Note: If you are upgrading from 9.2., please see instructions below for "Upgrading PostgreSQL from 9.2."
- Fork this repo into your personal Github account.
- Clone your copy to your desktop, then navigate to that directory.
- Next, install all required gems:
- If you run into an error
-bash: bundle: command not found, install the
bundlegem, then try again.
gem install bundle; bundle install
- Next, start postgres with command-line interface OR with PostgreSQL Mac OS X GUI. Make sure it is running before proceeding to next steps.
Finally, set up the database:
rake db:create db:migrate db:seed
This will build your database and populate it with some test data. If you are setting up a local development environment, ignore rake migration errors for now. Optionally instead of the
rake command, you can simply run
- Meetup API key is set as an environment variable. To register a new API key.
To run locally:
$ export MEETUP_API_KEY=[new key]
$ echo $MEETUP_API_KEY
- Add another remote:
git remote add upstream firstname.lastname@example.org:girldevelopit/gdi-new-site.git
- Now test your local dev environment by running
rails sand visiting http://0.0.0.0:3000. You should now see a local copy of the live website! \o/
Ubuntu installation instructions
- Install RVM Website Instructions
- Install the pgp key for rvm
sh gpg --keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3
- Install rvm, make sure to not run this as sudo, RVM should be installed on your user
sh curl -sSL https://get.rvm.io | bash -s stable
- Source the RVM scripts (the output from the install command has instructions for how to set this up permanently)
sh source ~/.rvm/scripts/rvm
- Install Ruby
rvm install 2.1.7
- Create a new Gemset
rvm gemset use gdi-new-site --create
- Install some system prereqs
sudo apt-get install build-essential libpq-dev imagemagick libmagickwand-dev nodejs
- Install and Configure Postgres Website Instructions
- Simple install (Try first, if it fails follow complex install)
sh sudo apt-get install postgresql-9.3
Complex install Note: Change precise to match the name of your ubuntu distribution (12.04 = precise, 14.04 = trusty)
sh echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main" > /etc/apt/sources.list.d/pgdg.list wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | \ sudo apt-key add - sudo apt-get update sudo apt-get install postgresql-9.3* Configure Source Note: Change
to your ubuntu username
sh sudo su postgres -c psql postgres=# CREATE ROLE <username> SUPERUSER LOGIN; postgres=# \q