brickhack.io

The public facing site for Brick Hack.

Getting Started

Mac OS X

Install ruby, mysql, and other required development environment tools.

$ brew install rbenv ruby-build rbenv-readline rbenv-gem-rehash rbenv-default-gems rbenv-binstubs
$ brew install redis
$ brew install mysql

Download & configure local environment, vendor everything style.

$ git clone git@github.com:codeRIT/brickhack.io.git
$ cd brickhack.io
$ rbenv install
$ bin/setup

Optionally, you can use Pow to host your local development environment. With it, you can visit http://brickhack.io.dev/

$ brew install pow
$ gem install powder
$ powder link

Afterwards, you can restart the server with powder restart when needed.

If you choose not to use Pow, you can still initiate a local rails server with bin/rails server and visit http://localhost:3000

Windows

Verify you have a unix console emulator. We recommend the full version of cmder.

Download & install RailsInstaller 3.0 (alpha) from http://railsinstaller.org/

Download & install redis from https://github.com/rgl/redis/downloads

Download & configure local environment, vendor everything style.

$ git clone git@github.com:codeRIT/brickhack.io.git
$ cd brickhack.io
$ bin/setup

Start your local environment: bin/rails server

Authenticaiton & Admin Testing

Authenticaiton is performed through MyMLH. To access the admin pages, you'll need to create a local account & add our test MyMLH credentials.

Copy the sample environment variables (cp .env.sample .env)
Replace the values in .env with our test MyMLH credentials. Contact a contributor to obtain these.
Start up the local server (bin/rails server)
Visit /manage and sign in. You'll be asked to sign up or sign in to MyMLH, and authorize the applicaiton. Upon doing so, you'll be redirected back to your local server.
Start up the Rails console (bin/rails console) and run the following command:

User.last.update_attribute(:admin, true)

You should now be able to access /manage (with bin/rails server still running)

Development Utilities

Mail View - Email templates can be previewed at http://localhost:3000/rails/mailers
Mail Catcher - When active, emails will be captured by MailCatcher instead of slipping into a black hole (no emails are ever sent in development). Visit mailcatcher.me and follow instructions under "How" to get setup. Note: in order for mail to be sent, you must start a local Sidekiq worker using bundle exec sidekiq.
Guard - Automatically runs tests based on the files you edit. bundle exec guard
Coverage - Test coverage can be manually generated via the bin/rails coverage:run command. Results are then made available in the coverage/ directory.
Sidekiq - Run background jobs (such as emails) and view active & completed jobs. Spin up Sidekiq with bundle exec sidekiq. A web portal will be available at http://localhost:3000/sidekiq (also available in production).

Deployment

Code pushed will automatically build on Travis CI. Upon a successful build to the develop or master branches, Travis will deploy to our instance(s) of Dokku. See the Production Environment Setup page for details.