Skip to content

itkg/itkg-data-reference-bundle

Repository files navigation

ReferenceBundle

Build Status Scrutinizer Code Quality Code Coverage

Installation

To install the project, you need to require it in your project composer.json file (adapt with version you need on your project).

{
    "require": {
        "itkg/itkg-data-reference-bundle": "~1.1"
    }
}

As the project is not published on packagist you need to complete the repositories section :

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/itkg/itkg-data-reference-bundle.git"
        }
    ]
}

Once the bundle is installed, enable it in the AppKernel.php file :

    new Itkg\ReferenceModelBundle\ItkgReferenceModelBundle(),
    new Itkg\ReferenceApiBundle\ItkgReferenceApiBundle(),
    new Itkg\ReferenceBundle\ItkgReferenceBundle(),

Then configure grunt to compile the bundles assets.

In the grunt/app_config.js file, add the bundle's Grunt targets:

module.exports = {
  targetsDir: [
    './vendor/itkg/itkg-data-reference-bundle/GruntTasks/Targets'
  ]
}

Add the concatenation task in the grunt/tasks/javascript_task.js :

module.exports = function(grunt) {
  grunt.registerTask(
    'javascript',
    'Main project task to generate javascripts',
    [
        'concat:referencebundlejs'
    ]
  );
};    

And in the main concatenation file grunt/targets/concat.all_js.js :

module.exports = {
  src: [
    'web/built/referencebundle.js'
  ]
}