Getting started with the OpenHatch code (moved): Difference between revisions
Content added Content deleted
No edit summary |
|||
Line 1: | Line 1: | ||
To get your own instance of OpenHatch running, follow these |
To get your own instance of OpenHatch running, follow these '''five steps''' and then get in touch with us. |
||
== |
== Clone our git repository == |
||
You will need to have the ''git'' version control system installed. Once you do, type this into a terminal: |
You will need to have the ''git'' version control system installed. Once you do, type this into a terminal: |
||
Line 9: | Line 9: | ||
It might take a while; it's kind of a big repository. (Like, a hundred megs.) |
It might take a while; it's kind of a big repository. (Like, a hundred megs.) |
||
== |
== Read the README == |
||
The repository is called '''milestone-a''' so you have to "cd" into it: |
The repository is called '''milestone-a''' so you have to "cd" into it: |
||
Line 21: | Line 21: | ||
'''That''' is what we really keep up to date with the necessary things. |
'''That''' is what we really keep up to date with the necessary things. |
||
== |
== 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: |
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: |
||
Line 29: | Line 29: | ||
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. |
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. |
||
== |
== 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: |
Once you've gone through these steps, just visit your own OpenHatch instance on the web. You can start the server with: |
||
Line 37: | Line 37: | ||
and load up http://localhost:8000/ in your web browser. |
and load up http://localhost:8000/ in your web browser. |
||
== |
== Get in touch == |
||
There's always someone on the #openhatch IRC channel in freenode. And you can join our Devel mailing list. |
|||
== 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. |
You can find more tips about hacking OpenHatch in other pages in the [[Category:Hacking_OpenHatch|Hacking OpenHatch category]] on this wiki. |