Permalink
Browse files

More clarification on how to setup SlimJim and some instructions on h…

…ow to contribute code
  • Loading branch information...
1 parent 3f2a25e commit 13783f7be54ab8232e628d036c89f57348ff6a46 @jesalg committed Sep 13, 2012
Showing with 46 additions and 2 deletions.
  1. +46 −2 README.md
View
@@ -1,7 +1,7 @@
SlimJim
=======
-### WHY!
+### WHY?
SlimJim was born out of a need for a simple auto update script which would update multiple development/test environments every time someone commits to their respective Github repository.
@@ -17,10 +17,14 @@ Now lets get to it. To configure SlimJim on your server follow these steps:
Basic LAMP setup should suffice. Everything you need is in this repo. I'm using a PHP micro-framework called Slim (thus the name!).
+Just don't forget to update the first line in deploy.php to point to the path of your SlimJim directory
+
Run slimjim.sql on your MySql server
For all the projects that you want to auto-update, add the name of the github repo, branch and the physical path on your server to the Projects table
+Modify the IPs in the allowed_from key in the settings table to make sure GitHub or any other site can POST to your endpoint.
+
**Install & setup [incron](http://inotify.aiken.cz/?section=incron&page=about&lang=en)**
When the site receives a payload from the post-receive hook it will drop a request in the /requests folder. Incron is needed to listen for that event and trigger the deploy script.
@@ -61,4 +65,44 @@ Go to Admin -> Service Hooks and add this URL:
``http://slimjim.yourcompany.com/deploy``
-That's it! Now sit back and watch Jim do the tedious work! :)
+That's it! Now sit back and watch Jim do the tedious work! :)
+
+### CONTRIBUTE!
+
+Now if you like what this does, feel free to improve upon code. Just follow these steps to contribute:
+
+* Fork SlimJim on GitHub & Clone your fork onto your machine
+
+ ``git clone git@github.com:[YOUR_USERNAME]/SlimJim.git``
+
+* Pull the *develop* branch from the upstream repository
+
+ ``cd SlimJim``
+
+ ``git remote add upstream git@github.com:jesalg/SlimJim.git``
+
+ ``git fetch upstream``
+
+ ``git checkout -b develop origin/develop``
+
+* Keep develop up-to-date
+
+ ``git fetch upstream``
+
+ ``git rebase upstream/develop develop``
+
+* Create a feature branch
+
+ ``git flow feature start my_cool_feature``
+
+* Hack Hack Hack
+
+ Make sure to commit your work in bite-size chunks, so the commit log remains clear.
+
+* When ready, push the feature branch to your origin
+
+ ``git push origin my_cool_feature``
+
+* Issue a [pull request](https://help.github.com/articles/using-pull-requests) to my *develop* branch
+
+* I will test out your cool feature on develop and do a release to master soon thereafter! :)

0 comments on commit 13783f7

Please sign in to comment.