You are browsing the documentation for version 3.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
To set up the development environment for Oro applications customization tasks, please follow the steps outlined in the sections below.
Meet the Hardware and OS Requirements
The recommended OS for Oro applications is CentOS. However, it is possible to set up the development environment on any Linux, Mac, or Windows OS.
A solid-state drive (SSD) is recommended. As Oro application uses lots of files (vendors, cache), an SSD makes everyday development operations much faster than when using HDD.
The recommended amount of available RAM is 8Gb for most development operations (e.g., upgrading the application or updating Composer dependencies). However, 2Gb of available RAM is usually enough to run the application.
Prepare Development Tools
Install Node.js to build application assets.
Install PHPStorm as the recommended IDE.
Although PHPStorm is recommended, it is not the required IDE for Oro application development. If you use a different IDE, skip the PHPStorm configuration steps below.
Install and configure Symfony plugin and Oro plugin by following the official PHPStorm plugin management instructions.
Exclude the following directories in PhpStorm (to avoid class duplication and indexation overhead) by right-clicking on the directory and selecting Mark Directory As > Excluded:
Enable code quality checks in PHPStorm:
Enable PHP Code Sniffer (use PSR2 or Symfony2 code standards)
Enable PHP Mess Detector, making sure that:
- Cyclomatic complexity DOES NOT exceed the limit of 15.
- The limit of the NPath complexity is set to 200 (the default PHPMD limit).
Configure xDebug * Integrate a debugging tool into your IDE to be able to set breakpoints in a code, see watches and go over a stack trace in real time. See how to set up integration between PhpStorm and xDebug.
Configure PhpUnit * If you write tests for your code, integrate PhpUnit with PhpStorm and use it for actual testing.
You can also set the default configuration for the PhpUnit test runner (path to phpunit.xml, the working directory, etc.). Then you can just right-click a test file and select Run <file> to run all tests from the file.
Create a Custom Application
Fork Oro application repository.
Use the Github guide on forking a repo as an illustration of how to fork the Oro application repository.
Pay attention to the Keep your fork synced section of this Github guide. You have to set the original Oro application repository as the remote upstream in order to be able to pull improvements and fixes from the original Oro application.
- (optional) Change the README.md file in your repo to describe your application.
- (optional) Change the package name of your application in the composer.json file.
Please be aware that in accordance with the Oro PHP Application structure, you have to use only the following folders and files to place your code in your custom application:
- src: the main folder for your customization code
- templates: the folder for template files
- config: folder the folder for config files
- translations: the folder for translation files
- README.MD: the file for the description of your custom application
- composer.json: the file which you can change if you want to make a package from your custom application
Setup Application Environment
Please, follow the Environment Setup for Community Edition or Environment Setup for Enterprise Edition to set up the environment for your custom Oro application.
If the OS on your development machine is other than CentOS, consider using a virtual machine running on CentOS to create the environment for your custom application.
Install Your Application
When the environment is set up, follow the instructions in the Installation Guide to install your application.
Create a Custom Bundle
All OroPlatform-based applications have unique features that facilitate smooth development routine, like autoregistration of bundles and configuration files, for example.
However, these features assume that all application code is organized in bundles. For this reason, you have to create your own bundle for your custom code to perform customization tasks.
Please, follow the How to Create a New Bundle cookbook article to create a bundle in your custom application.
A priority parameter of your bundle should be greater than 210 to make the bundle loaded after all Oro application bundles and to allow override of configuration files from Oro bundles.