03_get_started.md

Get started with datagrid component

Installation

Datagrid component uses composer and can be found on packagist.

As there is no tagged vbersion for now, you have to use dev-master version constraint.

$ ./composer.phar require jfsimon/datagrid:dev-master

If you want to contribute or run the unit tests, you'll have to install dev dependencies.

Run the tests

Tests need dev dependencies to be installed.

Datagrid component uses PHPUnit. To run the tests, simply call phpunit from the root component directory:

$ phpunit

Or from your project root directory:

$ phpunit -c vendor/jfsimon/datagrid

About renderers

For now, there is only one renderer based on Twig templating engine. If you use another templating system, please tell me, I'll implement a renderer based on it.