jd/draggy

Draggy - Visual code development tool and template engine

Draggy

Draggy is a code development tool and template engine that enables the user to create and maintain a functional Skeleton of an application., _(*1)

The installation instructions here are for installing Draggy as a vendor on an existing Symfony2 installation. If you are starting a new project, there is an easier way to get started by downloading a Symfony2 installation that already has Draggy bundled. For details please go to https://github.com/j-d/symfony-standard-draggy, _(*2)

Downloading that bundle package is the same as creating a new Symfony2 project and following the steps below., _(*3)

If you want to see a demo, you can download one from here: https://github.com/j-d/draggy-demo, _(*4)

Installation (as a vendor on an existing Symfony2 installation)

Edit your composer.json file and add draggy as a dependency, _(*5)

sudo nano composer.json

    "require-dev": {
        ...
        "jd/draggy": "dev-master"
        ...

Change the version of the Incenteev dependency as it doesn't currently (2.3) support additional parameters on the parameters.yml file:, _(*6)

    "require": {
        ...
        "incenteev/composer-parameter-handler": "2.1.*@dev"
        ...

Run composer update to download the recently added dependency, _(*7)

sudo composer update

Copy the parameters_draggy.yml.dist file from vendor/jd/draggy/app/config/ to app/config/ as parameters_draggy.yml, _(*8)

sudo cp vendor/jd/draggy/app/config/parameters_draggy.yml.dist app/config/parameters_draggy.yml

Edit your parameters.yml file to add an import of the parameters_draggy.yml file, _(*9)

sudo nano app/config/parameters.yml

    imports:
        - { resource: parameters_draggy.yml }
        ...

    parameters:
    ...

Edit the parameters_draggy.yml and configure the model file name and other parameters, _(*10)

sudo nano app/config/parameters_draggy.yml

parameters:
    draggy.model_filename:      <your_model_name>.xml
    draggy.model_path:          %kernel.root_dir%/../doc/
    draggy.model_history_path:  %kernel.root_dir%/../doc/history/
    draggy.model_xml_extension: .xml
    draggy.autocode.src_path:   %kernel.root_dir%/../src/

Create the folder where you are going to save the model, if it doesn't exist, _(*11)

mkdir doc

Crate the path where you are going to save the model history, if it doesn't exist, _(*12)

mkdir doc/history

Give write access to www-data to those folder, _(*13)

sudo apt-get install acl

sudo setfacl -R  -m u:www-data:rwx -m u:`whoami`:rwx doc doc/history
sudo setfacl -dR -m u:www-data:rwx -m u:`whoami`:rwx doc doc/history

Add doc/history to the .gitignore, _(*14)

sudo nano .gitignore

...
/doc/history/*
!.gitkeep

Register the DraggyBundle in the app\AppKernel.php (it is recommended to add it on the dev section), _(*15)

sudo nano app/AppKernel.php

if (in_array($this->getEnvironment(), array('dev', 'test'))) {
    ...
    $bundles[] = new Draggy\Bundle\DraggyBundle\DraggyBundle();
    $bundles[] = new Draggy\Bundle\MockBundle\MockBundle();
    ...

Modify the routing_dev.yml file to add Draggy routes, _(*16)

sudo nano app/config/routing_dev.yml

... 
_draggy:
    resource: "@DraggyBundle/Resources/config/routing.yml"
    prefix:   /_draggy/

If you are going to use the default Draggy mock templates, copy the custom form_div_layout.html.twig into the resources folder:, _(*17)

mkdir app/Resources/views/Form
cp vendor/jd/draggy/src/Draggy/Bundle/MockBundle/Resources/views/Form/form_div_layout.html.twig app/Resources/views/Form/form_div_layout.html.twig

and amend your config.yml file to use this twig template and add the MockBundle to assetic:, _(*18)

sudo nano app/config/config.yml

... 
twig:
    ...
    form:
        resources:
            - ':Form:form_div_layout.html.twig'
...
assetic:
    ...
    bundles:        [MockBundle]
    ...

Install the Draggy assets, _(*19)

sudo php app/console assets:install --symlink

That's it! To use it just browse to the path you created, e.g. http://myproject.local/app_dev.php/_draggy, _(*20)

Happy Draggy-ing!, _(*21)