Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 3.21 KB

README.md

File metadata and controls

63 lines (38 loc) · 3.21 KB
Raw

CFP-App

This is a Ruby on Rails application that you can deploy to manage your conference's call for proposal (CFP) and program. It was written by Ruby Central to run the CFPs for RailsConf and RubyConf. We've open sourced it so other organizers can use it themselves.

The CFP app is not the conference website but just to place for potential speakers to submit talks for your CFP. You'll end up pointing those interested in submitting a talk to your deployed version of this application. From there speakers can submit their talk, track their talk's progress and update their profile and talk details as need be. As an organizer you can have a group of reviewers that blindly look over proposals, give feedback, tag and rate them. You can have a different group of organizers that then sift through talks, curate your program, send out acceptance emails and manage the program. We'll get into the details of the specifics of all of these things below.

The app was written with a Heroku deployment stack in mind. The only two add-ons you'll need is a database and an email sending service. We used SendGrid but it shouldn't matter. You can deploy it wherever you'd like assuming it can run Ruby 2.1.2 and Rails 4.1.2 with a postgres database and an SMTP listener.

Setup

  • Required Items

Make sure you have Ruby 2.1 and Postgres installed in your environment. This is a Rails 4.1 app and uses bundler to install all required gems. We are also making the assumption that you're familiar with how Rails apps and setup and deployed. If this is not the case then you'll want to refer to documentation that will bridge any gaps in the instructions below.

  • Install gem requirements

    bundle install

    NOTE: You may need to install Qt/qmake to get Capybara to work; with Homebrew you can run brew install qt.

  • Duplicate and edit environment variables

    cp env-sample .env

Omniauth is set up to use Twitter and Github for logins in production. You'll want to put your own key and secret in for both. Other environment variables will include your postgres user and Rails' secret_token.

  • Duplicate and edit database.yml

    cp config/database_example.yml config/database.yml

  • Build dev database

    bundle exec rake db:create db:migrate db:seed

NOTE: Seed will make an admin user with an email of [email protected] to get started. There is a special, development only login method in Omniauth that you can use to test it out.

Environment variables

POSTGRES_USER (dev/test only)
MAIL_HOST (production only)
SECRET_TOKEN (production only)
GITHUB_KEY
GITHUB_SECRET
TWITTER_KEY
TWITTER_SECRET

Contributing

View our CONTRIBUTING.md file to see guidelines on how to make CFP App better.

Contributors

The CFP App was initially authored by Ben Scofield. Marty Haught took over the project and lead development for the CFP for RailsConf 2014. Below are the others that participating on the project while it was a private project.

  • Matt Garriott
  • Andy Kappen
  • Timothy King
  • Ryan McDonald
  • Scott Meade
  • Sarah Mei

It was open sourced in May 2014 and moved to its new home. Please view the contributor graph for those that have contributed since it was open sourced.