|
| 1 | +# hackety-hack.com |
| 2 | + |
| 3 | +Check it out! This is the source code for hackety-hack.com, which is the site for Hackety Hack! You can check it out at... http://hackety-hack.com ! |
| 4 | + |
| 5 | +## Requirements |
| 6 | + |
| 7 | +So you'd like to hack on the site, eh? No problem. It's built on a few things: |
| 8 | + |
| 9 | +* [Ruby](http://ruby-lang.org/) - Ruby is a great programming language. |
| 10 | +* [Sinatra](http://sinatrarb.com/) - Sinatra is a classy web framework in Ruby. |
| 11 | +* [Bundler](http://gembundler.com/) - Bundler manages gem dependencies. |
| 12 | +* [MongoDB](http://mongodb.com) - MongoDB is a sweet database. |
| 13 | +* [Git](http://git-scm.com/) - git is a Distributed Version Control System. |
| 14 | + |
| 15 | +This is all you need to get started! |
| 16 | + |
| 17 | +### Git |
| 18 | + |
| 19 | +To install git, check out the [download page](http://git-scm.com/download) on the git site. |
| 20 | +Once you have `git` installed, you can clone the repository: |
| 21 | + |
| 22 | +`git clone http://github.com/hacketyhack/hackety-hack.com.git` |
| 23 | + |
| 24 | +This will make a 'hackety-hack.com' directory in the current directory. |
| 25 | + |
| 26 | +### Ruby |
| 27 | + |
| 28 | +You probably already have Ruby 1.8.7 installed on your computer. If not, see [the download page](http://www.ruby-lang.org/en/downloads/). |
| 29 | + |
| 30 | +### Bundler |
| 31 | + |
| 32 | +Bundler is a Ruby gem, so you can use the `gem` program to install it: |
| 33 | + |
| 34 | +`gem install bundler` |
| 35 | + |
| 36 | +### Sinatra |
| 37 | + |
| 38 | +Since Sinatra is also a gem, you can install it (and all the other dependancies) with `bundle`: |
| 39 | + |
| 40 | +`cd hackety-hack.com` |
| 41 | +`bundle install` |
| 42 | + |
| 43 | +### MongoDB |
| 44 | + |
| 45 | +You can find instructions for installing MongoDB [on their website](http://www.mongodb.org/downloads). |
| 46 | + |
| 47 | +## Running the site |
| 48 | + |
| 49 | +Once you've got everything installed, make sure that you have the MongoDB server running. You'll probably use the `mongod` command to do this. I do this: |
| 50 | + |
| 51 | +`mongod` |
| 52 | + |
| 53 | +Next, use `rackup` to start a web server: |
| 54 | + |
| 55 | +`rackup config.ru` |
| 56 | + |
| 57 | +And you should have everything going on localhost, at port 9292. Open your browser to 'http://localhost:9292' and check it out! |
| 58 | + |
| 59 | +## Tests |
| 60 | + |
| 61 | +We use both RSpec and Cucumber for testing. You can run these two commands to run the tests: |
| 62 | + |
| 63 | +`rake spec` |
| 64 | +`rake features` |
| 65 | + |
| 66 | +And those will run the rspec and cucumber features, respectively. We're aiming for as large of test coverage as possible, though not quite 100%. More tests are always better! |
| 67 | + |
| 68 | +## Bug reports |
| 69 | + |
| 70 | +We use [GitHub Issues](http://github.com/hacketyhack/hackety-hack.com/issues) to keep track of bugs and the features that we'd like to have. If you're looking for something to do, you can try checking there! |
0 commit comments