Get the Source Code and Install Dependencies¶
Obtain the application source code and install or update the required dependencies in one of the following ways:
- Clone the GitHub repository and install dependencies.
- Download the source code archive and install dependencies.
These methods are detailed below.
Method 1: Clone the GitHub Repository and Install Dependencies¶
Note
Alternatively, you can Download the source code archive.
To prepare for installation:
Clone the Oro application GitHub repository:
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]
Obtain the Oro application source files using the git clone command.
On Linux, use the following command:
$ git clone -b <version_or_branch> <repository_URL> [$oro_installation_folder]
- Replace the <version_or_branch> with the version to download. Along with the released versions (like
1.3
and2.3
), 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 2.3 https://github.com/oroinc/crm-application.git orocrm
OroCommerce (with CRM):
$ git clone -b 1.3.0 https://github.com/orocommerce/orocommerce-application.git orocommerce
OroPlatform:
$ git clone -b 2.3 https://github.com/oroinc/platform-application.git oroplatform
- Replace the <version_or_branch> with the version to download. Along with the released versions (like
Method 2: Download the Source Code Archive and Install Dependencies¶
Note
Alternatively, you can Clone the GitHub repository.
To prepare for installation:
Download the latest version of the application from the download section on oroinc.com/orocrm. Click the zip, tar.gz, or tar.bz2 link to download the archive.
Note
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.
Run the
composer install
command with--prefer-dist --no-dev
parameter to update the downloaded libraries to the latest supported versions (The source code archive contains all the required libraries. They will be installed to thevendor
directory):$ cd [$oro_installation_folder] $ composer install --prefer-dist --no-dev
Warning
Unlike when downloading 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
app/config/parameters.yml
file after the command execution is complete.