Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.49 KB

README.md

File metadata and controls

42 lines (26 loc) · 2.49 KB

hackety-hack.com

Build statusCode ClimateCoverage Status

hackety-hack.com is the web backend powering the collaborative features of Hackety Hack. It is written in Rails 3 and continues to be under active development (see 'Helping Out'), the switch to Rails 3 happened quite recently so there's still lots to be done.

Helping Out

If you have any experience writing Rails apps, feel free to help out, we're open to pull requests as long as you follow a few conditions.

  • Test your code, we really can't stress this enough, ideally you should be practicing TDD and writing tests before you even write your code. If you don't test your code, we have no way of knowing if it works properly so please do test.
  • If it's a major feature, file an issue, if you file an issue we can discuss certain aspects of the new feature with you and ensure it's a good fit for hackety-hack.com.

Getting Started

Once you've cloned this repository, running script/bootstrap should tell you everything you need to know.

In case you prefer gems to be managed entirely by bundler run this before bootstrapping:

bundle config --global path .bundle
bundle config --global binstubs bin
export PATH="$PWD/bin:$PATH"

Be careful with using bin in $PATH it is very risky when used with public projects.

Dependencies for the curious:

  • Ruby: 1.9.3 is preferred.
  • MongoDB: 2.2.x or 2.4.x

As long as you have those things, the script will handle the rest as best it can, including installing the gem dependencies with Bundler.

If the tests aren't passing when you clone, open an issue or drop into #hacketyhack on freenode.

Additionally, if you're not a developer and you have a feature you'd really like to see on the site, file an issue and we'll be sure to look into it on your behalf.