Get the Oro Application Source Code¶

Method 1: Create a Project with Composer¶

1. Make sure you are using PHP 7.1.26 or higher and have Composer installed. If you do not, use Composer installation process described in the official documentation.

2. Create your new project in the directory where you plan to put the Oro application source files ([$folder_location]) by running:

   $ composer create-project oro/platform-application [$folder_location] --repository=https://satis.oroinc.local
   

Method 2: Use the GitHub Repository¶

1. Clone the Oro application GitHub repository:

   1. Go to the directory where you plan to put the Oro application source files ([$folder_location]). For example, on a Linux server, run the following command:

      $ cd [$folder_location]
      

   2. Obtain the Oro application source files using the git clone command.

      On Linux, use the following command:

      $ git clone -b <version> <repository_URL> [$oro_installation_folder]
      

      • Replace the <version> with the version to download. Along with the released versions (like 3.1.2), you can use the master branch to run the latest development version of the Oro application.
      • In [$oro_installation_folder] parameter, specify the directory to clone the application source files into.
      • Replace the <repository_URL> with the GitHub URL of the repository to clone, e.g., https://github.com/oroinc/crm-application.git.

      Note

      Adjust the sample commands below to your environment and installation plan:

      OroCRM:

      $ git clone -b 3.1.2 https://github.com/oroinc/crm-application.git orocrm
      

      OroCommerce (with CRM):

      $ git clone -b 3.1.2 https://github.com/orocommerce/orocommerce-application.git orocommerce
      

      OroPlatform:

      $ git clone -b 3.1.2 https://github.com/oroinc/platform-application.git oroplatform
      

2. Run the composer install command with --prefer-dist --no-dev parameter to install all Oro application dependencies:

$ cd [$oro_installation_folder]
$ composer install --prefer-dist --no-dev

Note that you are prompted to enter the installation environment configuration and that are saved into the config/parameters.yml file. A description for every parameter you can find in the Infrastructure-related Oro Application Configuration article.

Method 3: Download the Source Code Archive¶

1. Download the latest version of the application source code from the download section on oroinc.local/orocrm. Click the zip, tar.gz, or tar.bz2 link to download the archive.

Note

You can also download the virtual machine to quickly deploy the application in the virtual sandbox environment.

Then extract the source files. For example, on a Linux based OS run:

$ cd [$folder_location]
$ tar -xzvf crm-application.tar.gz

The directory you extracted the files to, will be used in the following steps and will be referred to as [$oro_installation_folder] further in this topic.

2. All required dependencies already installed in the vendor folder in the extracted archive.

   Warning

   Unlike when cloning from the GitHub repository, you are not prompted to enter the configuration parameter values. Default values are used instead. If necessary, update configuration parameters in the config/parameters.yml file after the command execution is complete.