Skip to content
This repository has been archived by the owner on May 30, 2019. It is now read-only.

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mmoreram committed Jun 24, 2015
1 parent 44a7661 commit 5651d75
Showing 1 changed file with 40 additions and 27 deletions.
67 changes: 40 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,35 +21,28 @@ the rest.

## Requirements

We're trying to build this project with a light default dependencies.

### PHP

To use Bamboo and Elcodi you need a PHP version not less than **5.4**

For more info just visit their
[installation page](http://php.net/manual/en/install.php)

### Redis

Bamboo uses redis to make the app lighter and to minimize the response time.

For more info just visit their
[installation page](http://redis.io/topics/quickstart)

In order to use the last Redis features, like the `HyperLogLog` commands, be
sure your Redis version is at least `v2.8.9`.

Also, don't forget to install the php extension for redis.
### PHP GD

### Imagick

Images are a really important part of an store. Bamboo uses Imagick to
Images are a really important part of an store. Bamboo uses PHP GD to
resize and optimize all product images

For more info just visit their
[installation page](http://php.net/manual/en/imagick.setup.php)
[installation page](http://php.net/manual/en/image.installation.php)

> This PHP extension is used to being already installed when you add PHP in your
> distribution
> On the installation step you will be asked to provide the Imagick installation
> path. Ensure to configure the parameter **imagick_convert_bin_path** right
After that, you will be able to change the adapter and use other
implementations.

### MySQL

Expand All @@ -71,17 +64,31 @@ command:
$ curl -s http://getcomposer.org/installer | php
```

### Redis

Bamboo uses redis to make the app lighter and to minimize the response time.

For more info just visit their
[installation page](http://redis.io/topics/quickstart)

In order to use the last Redis features, like the `HyperLogLog` commands, be
sure your Redis version is at least `v2.8.9`.

Also, don't forget to install the php extension for redis.

## Installation

If you're used to working with LAMP environment, then you will have Bamboo
running in your computer in less than 5 minutes.

### 1. Install the project

After installing composer you can create your new bamboo project. Feel free to
use any version, but we're still creating new features, fixing some issues and
errors, and building our first release, so be sure you are not using master, but
a closed version of the package.
errors, and building our first release, so feel free to use them

``` bash
$ php composer.phar create-project elcodi/bamboo path/to/your/store/ 0.5.*
$ php composer.phar create-project elcodi/bamboo bamboo -sdev
```

> The installation process will ask you for some parameters like the database
Expand All @@ -90,7 +97,7 @@ $ php composer.phar create-project elcodi/bamboo path/to/your/store/ 0.5.*
Enter your directory to start the configuration step

``` bash
$ cd path/
$ cd bamboo/
```

### 2. Init your database
Expand All @@ -108,19 +115,24 @@ store in a testing mode, with some categories, some manufacturers and a bunch of
t-shirts. Only for testing purposes :)

``` bash
$ php app/console doctrine:fixtures:load --fixtures="src/Elcodi/Fixtures" --no-interaction
$ php app/console doctrine:fixtures:load \
--fixtures="src/Elcodi/Fixtures" \
--fixtures="src/Elcodi/Plugin" \
--no-interaction
```

These fixtures will not install you any location data, but don't worry, we
provide you several ways for your location population.

> At the moment, only for Spain and France
We provide you some files with some countries dumped. You will find these files
inside `elcodi/geo-bundle` package, inside the `DataFixtures/ORM/Dumps` folder.
Because location tables are not using foreign keys, you can play with them as
much as you need.

``` bash
$ mysql -uroot -proot bamboo < vendor/elcodi/elcodi/src/Elcodi/Bundle/GeoBundle/DataFixtures/ORM/Dumps/spain.sql
```

You can also add the geo information for any country. Just find the two letters
[ISO code](http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the
country you want to load and launch the following command changing ES with your
Expand All @@ -130,7 +142,8 @@ code.
$ php app/console elcodi:locations:populate ES
```

> This could take several minutes per country, be patient
This could take several minutes per country, be patient and provide PHP as much
memory as possible.

### 3. Load the plugins

Expand All @@ -156,8 +169,8 @@ Finally our store is ready to run :)
$ php app/console server:run
```

> You can also [configure a Web server] like Apache or Nginx to run the app like
> all the Symfony apps.
You can also [configure a Web server] like Apache or Nginx to run the app like
all the Symfony apps.

### 5. Visit your store

Expand Down

0 comments on commit 5651d75

Please sign in to comment.