Difference between revisions of "Developers/Re-generating the environment"

From PartKeepr Wiki
Jump to: navigation, search
(Created page with "PartKeepr uses quite a few helper bundles from Symfony2: * [https://github.com/nfq-alpha/sprite-generator NFQ-Alpha Sprite Generator] creates a [https://en.wikipedia.org/wiki...")
 
Line 2: Line 2:
  
 
* [https://github.com/nfq-alpha/sprite-generator NFQ-Alpha Sprite Generator] creates a [https://en.wikipedia.org/wiki/Sprite_(computer_graphics)#Sprites_by_CSS CSS sprite sheet] from individual icons
 
* [https://github.com/nfq-alpha/sprite-generator NFQ-Alpha Sprite Generator] creates a [https://en.wikipedia.org/wiki/Sprite_(computer_graphics)#Sprites_by_CSS CSS sprite sheet] from individual icons
 +
** If you add sprite sheets, you must run '''php app/console nfq:sprite:generate'''. This must be done prior '''assetic:dump'''.
 
* Doctrine Reflection Bundle generates [http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.data.Model ExtJS Models] from [http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html Doctrine Entities]
 
* Doctrine Reflection Bundle generates [http://docs.sencha.com/extjs/6.0/6.0.0-classic/#!/api/Ext.data.Model ExtJS Models] from [http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html Doctrine Entities]
 +
** If you change the Doctrine entities, you must run '''php app/console generate:extjs:entities''' to re-generate the ExtJS Models.
 
* [http://symfony.com/doc/current/cookbook/assetic/asset_management.html Assetic] combines and minifies the source JavaScript
 
* [http://symfony.com/doc/current/cookbook/assetic/asset_management.html Assetic] combines and minifies the source JavaScript
 +
** If you change JavaScript source, you must run '''php app/console assetic:dump''' to minify the JS files. Note that this should '''not''' be required if you are using the [[Developers/Getting_Started#dev_Environment|dev environment]].
  
 +
In order to make re-generating the environment easier and consistent, you can use [https://www.phing.info/ phing]. PartKeepr provides a '''build.xml''' file. To re-generate the environment, call:
  
If you change the Doctrine entities, you must run <pre>php app/console generate:extjs:entities</pre> to re-generate the ExtJS Models.
+
<pre>
 +
phing -Denv=yourenvironment regenerate-environment
 +
</pre>
  
If you change JavaScript source, you must run <pre>php app/console assetic:dump</pre> to minify the JS files. Note that this should '''not''' be required if you are using the '''dev''' environment.
+
The default environment is '''prod''' if you skip '''-Denv'''.

Revision as of 13:15, 10 October 2015

PartKeepr uses quite a few helper bundles from Symfony2:

  • NFQ-Alpha Sprite Generator creates a CSS sprite sheet from individual icons
    • If you add sprite sheets, you must run php app/console nfq:sprite:generate. This must be done prior assetic:dump.
  • Doctrine Reflection Bundle generates ExtJS Models from Doctrine Entities
    • If you change the Doctrine entities, you must run php app/console generate:extjs:entities to re-generate the ExtJS Models.
  • Assetic combines and minifies the source JavaScript
    • If you change JavaScript source, you must run php app/console assetic:dump to minify the JS files. Note that this should not be required if you are using the dev environment.

In order to make re-generating the environment easier and consistent, you can use phing. PartKeepr provides a build.xml file. To re-generate the environment, call:

phing -Denv=yourenvironment regenerate-environment

The default environment is prod if you skip -Denv.