Author: shevek Date: 2013-01-21 19:22:23 +0100 (Mon, 21 Jan 2013) New Revision: 593 Added: trunk/DEV_GUIDE Log: Created DEV_GUIDE for MC, including README contents Added: trunk/DEV_GUIDE =================================================================== --- trunk/DEV_GUIDE (rev 0) +++ trunk/DEV_GUIDE 2013-01-21 18:22:23 UTC (rev 593) @@ -0,0 +1,63 @@ +* Move Commons Developer's Guide +NOTE: This document is best viewed with GNU Emacs Org-mode + +This is the Move Commons (MC) guide for developers. Move Commons is a simple tool for connecting potential volunteers and contributors to initiatives, collectives and NGOs. Check http://movecommons.org for more information. + +** General info +The community uses this SVN repository: +https://ourproject.org/scm/?group_id=981 +and this Redmine as Bug Tracking System: +http://redmine.ourproject.org/projects/movecommons/ + + +** Directory Structure +- movecommons/trunk (from now on "trunk") is the main tree +- trunk/audio contains audio for creating a video for MC: http://blip.tv/jpzafra/move-commons-for-humans-5578148 based on this old presentation: http://prezi.com/m2tim3hsyddh/move-commons/ +- trunk/gwt contains the deprecated draft of a form in GWT for integration in Kune (http://kune.ourproject.org) +- trunk/images contains images used for the video and presentations of MC +- trunk/src contains the source code of the MC form, the MC donate form, and other related source code for MC +- trunk/utils contains utilities related to the MC webpage +- trunk/wp-theme contains the Wordpress Theme used in the MC webpage (http://movecommons.org). + + +** Form development +The old form of MC is +http://movecommons.org/preview/ +The development version of the new form: +http://movecommons.org/test-form2/ + +trunk/src includes the source code of the old form and the new form. + +For modifications of the new form, focus on: +- trunk/src/mc-dia-form2.css +- trunk/src/mc-dia-form2.js +- trunk/wp-theme/mc2-form.php +It uses JQuery JS/CSS and images from trunk/src/images. + + +** Deployment instructions +For deployment you will need fabric: + apt-get install fabric + +If your ourproject-user is different for your system user, you should include 'user = your-op-user' (without the quotes) in the file ~/.fabricrc (create it if it doesn't exist). + +After performing changes in the repository, you should do something like: + fab deploy +to commit and update the MC website. + +For other options: + fab --list + +NOTE: After changes in the JavaScript, the "fab deploy" correctly deploys the source, but the wordpress website does not show correctly the new JS (it will show the old JS, before the deploy). This is due to the caching of the browser and of the wordpress site. In order to fix this, please delete your browser cache and log-in to the wordpress website, so the cache is not used. Afterwards, the correct last version will be shown. + + +** i18n instructions +Please translate with gettext tools. For the wordpress website http://movecommons.org, use: + trunk/wp-theme/languages/ + +If we need to generate the pots again (if we update our php file strings): + php makepot.php wp-theme . languages/mc.pot +makepot.php is here http://svn.automattic.com/wordpress-i18n/tools/trunk/ + +Concerning the form translation, check + trunk/wp-theme/mc-languages/