Getting started with the OpenHatch code (moved): Difference between revisions
(Created page with 'Category:Hacking_OpenHatch') |
No edit summary |
||
Line 1: | Line 1: | ||
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 |
|||
== 2. Read the README == |
|||
Once you change directory into the milestone-a directory: |
|||
$ cd milestone-a |
|||
and read the embedded README.mkd file. |
|||
$ 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 [[Category:Hacking_OpenHatch|Hacking OpenHatch category]] on this wiki. |
|||
[[Category:Hacking_OpenHatch]] |
[[Category:Hacking_OpenHatch]] |
Revision as of 22:47, 23 August 2010
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
2. Read the README
Once you change directory into the milestone-a directory:
$ cd milestone-a
and read the embedded README.mkd file.
$ 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.