qxh5696 / brickhack.io

The public-facing site for BrickHack

brickhack.io

The public facing site for BrickHack.

• Hacker applications: Users sign up/in using MyMLH, which includes standard hackathon application info. This pre-fills the BrickHack application, so hackers don't have to duplicate information!
• Acceptance, RSVPs: Manage applications & coordinate acceptance/waitlist/denials
• Bus Lists: Coordinate bus sign-ups during the RSVP process while communicating important information to riders & captains
• Email communication: Ensure hackers get consistent, timely information throughout their application process, while enabling the organizing team to communicate important information at any time.
• Statistics & Visualization: Surface key information about the application base, distribution of applicants, progress towards attendance, etc.

Getting Started

macOS

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

$ brew install rbenv ruby-build rbenv-binstubs
$ brew install redis
$ brew install mysql

Ensure you have Git set up and SSH access to GitHub. If you have Git but not SSH, you can clone using the HTTPS url, however you'll have to type in your GitHub credentials every time.

Download & configure local environment, vendor everything style.

$ git clone [email protected]:codeRIT/brickhack.io.git
$ cd brickhack.io
$ rbenv install
$ bin/setup

Optionally, you can use Pow to host your local development environment. This enables you to use http://brickhack.io.dev/ as your local URL, without having to manually run rails server.

$ 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

Note: This setup is outdated. Contributions welcome!

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

Download & install RailsInstaller from http://railsinstaller.org/. Use the latest version.

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

Download & configure local environment, vendor everything style.

$ git clone [email protected]: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.

1. Copy the sample environment variables (cp .env.sample .env)
2. Replace the values in .env with our test MyMLH credentials. Contact a contributor to obtain these.
3. Start up the local server (bin/rails server)
4. 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.
5. Start up the Rails console (bin/rails console) and run the following command:

User.last.update_attribute(:admin, true)

5. 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).

Development & Deployment

All development work should be done locally in a new branch and/or fork. Then, make a pull request to have the code merged into the develop branch. Once the develop branch gets to a good state, it gets merged into the master branch for a production deployment.

Code pushed to any codeRIT/brickhack.io branch will automatically build on Travis CI for tests. Any build on the develop or master branches will also trigger a deploy to our instance(s) of Dokku - staging for develop, production for master.

See the Production Environment Setup page for details.