Giter Club home page Giter Club logo

brickhack.io's Introduction

brickhack.io Build Status Code Climate Test Coverage

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 [email protected]: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 [email protected]:codeRIT/brickhack.io.git
$ cd brickhack.io
$ bin/setup

Start your local environment: bin/rails server

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/rake 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.

brickhack.io's People

Contributors

ahollenbach avatar benkantor avatar bitbanger avatar clehner avatar coldencullen avatar dxn7335 avatar gabe-k avatar liam-middlebrook avatar maxwofford avatar mmeyer724 avatar nateperry avatar piedoom avatar piperchester avatar pxlbuzzard avatar sman591 avatar wilfriede avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.