README

PlatformUIBundle is a bundle for eZ Platform providing a web application to manage your content and administrate your eZ Platform install.

If you find a bug, please create an issue in JIRA and don't forget to add as much details as you can (steps to reproduce, OS and browser(s) versions, ...) and to put PlatformUI (Admin UI & Content IU) in the Component/s field. Before submitting an issue you can also consult the list of opened bugs or the complete list of reported bugs, improvements or stories.

If you discover a security issue, please see how to responsibly report such issues on https://doc.ez.no/Security

Installation

eZ Platform 1.0 (2015.11) or higher are required to run the PlatformUI.

PlatformUI and its dependencies are installed and setup by default in eZ Platform. To run PlatformUI, you just have to open http://[uri_of_ez]/ez in your favorite browser.

If for whatever reason, PlatformUIBundle is not installed, here is what you need to do:

• From your eZ Platform installation, run composer:

  $ composer require ezsystems/platform-ui-bundle:dev-master
  

• In app/AppKernel.php add an instance of the following classes to the list of registered bundles:

  public function registerBundles()
  {
      $bundles = array(
          // enabled bundles
          // ...
  
          new EzSystems\PlatformUIBundle\EzSystemsPlatformUIBundle(),
          new EzSystems\PlatformUIAssetsBundle\EzSystemsPlatformUIAssetsBundle(),
          new EzSystems\RepositoryFormsBundle\EzSystemsRepositoryFormsBundle(),
      );
  }

• In app/config/routing.yml include the eZPlatformUIBundle routing configuration:

  _ezpublishPlatformUIRoutes:
      resource: "@eZPlatformUIBundle/Resources/config/routing.yml"

• Make sure the REST API is configured to use the session based authentication.

• Run the following command:

  $ php app/console assets:install --symlink
  

If you are running eZ Platform in the prod environment, you also need to dump the assets for Assetic with:

php app/console assetic:dump --env=prod

Once this is done, you can go to http://[uri_of_ez]/ez to run the eZ Platform UI application.

Developers tasks

Most developer related tasks can be run with Grunt and have several additional dependencies:

• Install grunt, yuidoc, bower and grover globally (usually you need to be root):

  # npm install -g grunt-cli yuidocjs grover bower gulp
  

• Install phantomjs version 1.9.x

• Install local npm and bower dependencies, from the bundle root, run:

  $ npm install
  $ bower install
  

Once this is done, you can use any tasks registered in Grunt, the most interesting are:

• Running the JavaScript unit tests

  $ grunt test
  

• Running a single JavaScript unit test

  $ grover --server --console Tests/js/foo/bar/somefile.html
  

• Generate a code coverage from those tests:

  $ grunt coverage
  

  The HTML coverage report is then available in Tests/report/lcov-report/index.html.

• Generate the JavaScript API doc:

  $ grunt doc
  

• Alternatively, you can run a live documentation server that will be available at http://127.0.0.1:3000 :

  $ grunt livedoc
  

• Update the custom AlloyEditor skin:

  $ composer install # or composer update
  $ cd vendor/ezsystems/platform-ui-assets-bundle/Resources/public/vendors/alloy-editor/
  $ npm install
  $ cd -
  $ grunt alloy-css

• To test updating custom AlloyEditor skin against custom platform-ui-assets-bundle builds:

  $ composer install --prefer-source
  $ cd vendor/ezsystems/platform-ui-assets-bundle/
  $ git checkout <your_branch>
  $ ./bin/prepare_release.sh -v X.Y.X
  $ git checkout vX.Y.X
  $ echo -e `cd Resources/public/vendors/alloy-editor/ && npm install`
  $ cd -
  $ grunt alloy-css

To run the PHP unit tests, you first need to install the dev dependencies of the bundle. To do that, from the bundle root, run:

$ composer install --prefer-dist

Then, you can run the unit tests with:

$ php vendor/bin/phpunit