Skip to content

Latest commit

 

History

History
103 lines (62 loc) · 3.27 KB

index.rst

File metadata and controls

103 lines (62 loc) · 3.27 KB
Raw

Quick start

Let's get started. We'll guide you step by step through installing and running ONGR the first time. The first installation should not need more than 1 hour.

Step 1: Requirements.

  • Your machine has to be powerful enough to run Vagrant and Puppet.
  • Linux/Unix or OS X based environment.
  • For Linux environment you might need to enable virtualization support in your BIOS (more info).
  • For OS X environment you will need command line tools aka XCode.

We do not support Microsoft Windows as a development environment. This might change in the future but for now you either need Linux/Unix based environment or OS X.

Step 2: Download ONGR

You can download the latest release using composer by typing:

composer create-project ongr/ongr-sandbox --no-interaction

Or you can download it from the archive and unpack it somewhere under your project directory. Make sure that we have the "Vagrantfile" in the your project root folder.

Step 3: Install Virtual Box

Either install or upgrade virtualbox. We need VirtualBox > 4.3

Step 4: Install Vagrant

Either install or upgrade vagrant. We need Vagrant >= 1.6.5

(optional) Now we need to install the hosts updater vagrant plugin.

vagrant plugin install vagrant-hostsupdater
It will help to automatically update /etc/hosts file via adding your new ongr.dev host with correct IP.

And finally - ONLY_FOR_LINUX you need to install the nfs server:

sudo apt-get install nfs-kernel-server

Step 5: Start virtual machine using Vagrant

Let's rock. Move into your project root folder and execute:

vagrant up

Note

Currently we have only Virtualbox provider support. We are working on others and soon should be docker provider ready to use.

That's it. The ONGR is alive.

If you experience any problems (e.g. vagrant tends to change the rules with each update and we might lag a bit) please do not hesitate to contact us. We'll help.

Now, let's feed the donkey with some data.

Step 6: Install the demo data

In case to get demo content you need to run the following commands from command line:

vagrant ssh
composer install --no-interaction
app/console es:index:create
app/console es:type:update --force
app/console es:index:import --raw src/ONGR/DemoBundle/Resources/data/categories.json
app/console es:index:import --raw src/ONGR/DemoBundle/Resources/data/products.json
app/console es:index:import --raw src/ONGR/DemoBundle/Resources/data/contents.json
If composer prompts input questions just press enter.

Note

Command "composer install --no-interaction" is not necessary if you downloaded project using composer.

Step 7: Open your browser

Navigate your browser to http://ongr.dev