Getting started with the OpenHatch code (moved)

To get your own instance of OpenHatch running, follow these simple steps:

1. Clone our git repository

You will need to have the git version control system installed. Once you do, type this into a terminal:

$ git clone git://code.openhatch.org/milestone-a.git

It might take a while; it's kind of a big repository. (Like, a hundred megs.)

2. Read the README

The repository is called milestone-a so you have to "cd" into it:

$ cd milestone-a

There you'll find a README.mkd file. Give it a careful read.

$ less README.mkd

That is what we really keep up to date with the necessary things.

3. Run the tests

We have automated tests that help us know when we've broken functionality in the OpenHatch code. Running the tests is a good way to make sure your OpenHatch environment works properly! Try this:

$ ./bin/sqlite_mysite test missions

That runs the test suite for just the missions part of the code. It uses the sqlite-based test runner so it runs fast; the real website uses MySQL, not SQLite, but you'll discover that tests run about 10 times faster in the sqlite runner.

4. Play with your local install

Once you've gone through these steps, just visit your own OpenHatch instance on the web. You can start the server with:

$ ./bin/mysite runserver

and load up http://localhost:8000/ in your web browser.

5. Read more documentation

You can find more tips about hacking OpenHatch in other pages in the on this wiki.