Skip to content

Latest commit

 

History

History
150 lines (100 loc) · 6.36 KB

Readme.md

File metadata and controls

150 lines (100 loc) · 6.36 KB
Raw

24 Pull Requests

Build Status Dependency Status Code Climate Test Coverage Gitter chat PullReview stats

Giving back little gifts of code

24 Pull Requests is a yearly initiative to encourage developers around the world to send a pull request every day in December up to Christmas.

This is the site to help promote the project, highlighting why, how and where to send your pull requests.

Get started!

Contributors

Over 120 different people have contributed to the project, you can see them all here: https://github.com/24pullrequests/24pullrequests/graphs/contributors

Development

Source hosted at GitHub. Report issues/feature requests on GitHub Issues. Follow us on Twitter @24pullrequests. We also hangout on Gitter.

Getting Started

New to Ruby? No worries! You can follow these instructions to install a local server, or you can use the included Vagrant setup.

Installing a Local Server

First things first, you'll need to install Ruby 2.0. I recommend using the excellent rbenv, and ruby-build

rbenv install 2.1.5
rbenv global 2.1.5

Next, you'll need to make sure that you have PostgreSQL installed. This can be done easily on OSX using Homebrew or by using http://postgresapp.com. Please see these further instructions for installing Postgres via homebrew.

brew install postgres phantomjs

On Debian-based Linux distributions you can use apt-get to install Postgres:

sudo apt-get install postgresql postgresql-contrib

On Windows, you can use the Chocolatey package manager to install Postgres:

choco install postgresql

Now, let's install the gems from the Gemfile ("Gems" are synonymous with libraries in other languages).

gem install bundler && rbenv rehash
bundle install

Once all the gems are installed, we'll need to create the databases and tables. Rails makes this easy through the use of "Rake" tasks.

bundle exec rake db:create:all
bundle exec rake db:migrate

And we can also add some sample data with the seed task

bundle exec rake db:seed

If you are working on anything related to the email-generation code, you can use mailcatcher Since we use bundler, please read the following before using mailcatcher

Almost there! Now all we have to do is start up the Rails server and point our browser to http://localhost:3000

bundle exec rails s

Using Vagrant

The included Vagrant setup uses Ansible as provisioner. First, you'll need to install the dependencies:

Windows Users: Ansible does not support Windows as controller machine, but there's a little hack in the Vagrantfile that will allow you to run the provision using a local SSH connection Guest-Guest. Just install Vagrant and VirtualBox, and you should be able to get it running.

Once you have everything installed, go to the project directory via console and run:

$ vagrant up

The first time you run vagrant up, the process will take several minutes, since it will download a box and run all necessary tasks to get the server ready. When the process is finished, log in to run the rails dev server:

$ vagrant ssh
$ cd /vagrant
$ bundle exec rails s

Then you should be able to access the application through your regular browser at http://192.168.12.34:3000.

Simply edit the files in the project directory using your favorite editor on your host machine and the changes will be automatically reflected in the /vagrant directory inside the guest virtual machine and so you can see the changes on your browser.

Tests

Standard RSpec/Capybara tests are used for testing the application. The tests can be run with bundle exec rake.

Mocha/Konacha is used for unit testing any JavaScript. JavaScript specs should be placed in spec/javascripts. Run the JavaScript specs with bundle exec rake konacha:serve.

If you are using the omniauth environment variables (GITHUB_KEY, GITHUB_SECRET, TWITTER_KEY, TWITTER_SECRET) for another project, you will need to either

  • unset them before running your tests or
  • reset the omniauth environment variables after creating a Github (omniauth) application for this project

as it will use it to learn more about the developers and for pull requests.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Send a pull request. Bonus points for topic branches.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Copyright

Copyright (c) 2014 Andrew Nesbitt. See LICENSE for details.