claretcrab / bamboo

Hitch your bamboo to a star! http://bamboo.elcodi.com

Bamboo e-commerce

Warning. This project is not tagged as stable yet. It means that we don't promise BC between minor versions or patch versions. As soon as possible, we will release our first Release Candidate, and the first Stable Version will be release on June 1st. Stay Tuned and enjoy Elcodi.

Welcome to Bamboo e-commerce - a fully-functional e-commerce application built using Elcodi components on top of the Symfony framework.

Yes, you got it right! Bamboo uses the Symfony framework but our components are framework agnostic, that is, they only depend on the Symfony components.

Why should I use Symfony? That's simple, to sell. We provide you with an interface to sell and to manage your store. You only have to focus on offering a good product, we take care of the rest.

Requirements

PHP

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

For more info just visit their installation page

Redis

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

For more info just visit their installation page

Imagick

The images are a really important part of an store. Bamboo uses Imagick to resize and optimize all the product images

For more info just visit their installation page

On the installation step you will be asked to provide the Imagick installation path. Ensure to configure the parameter imagick_convert_bin_path right

MySQL

And, where do you save your data? By default we use MySQL, remember to install it as well as its extension for PHP

For more info just visit their installation page

Composer

Composer is required to manage dependencies.

if you have not yet installed Composer, download it following the instructions on http://getcomposer.org/ or just run the following command:

    $ curl -s http://getcomposer.org/installer | php

Installation

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.

    $ php composer.phar create-project elcodi/bamboo path/ 0.4.*

The installation process will ask you for some parameters like the database driver, username, password, database name, etc

Enter your directory to start the configuration step

    $ cd path/

2. Init your database

Now we should create the database and all the application schema. Symfony provides you an easy way for doing that.

    $ php app/console doctrine:database:create
    $ php app/console doctrine:schema:create

We also load some fixtures to show on our store. This fixtures will set your store in a testing mode, with some categories, some manufacturers and a bunch of t-shirts. Just for testing :)

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

You can also add the geo information for any country. Just find the two letters ISO code for the country you want to load and launch the following command changing ES with your code.

    $ php app/console elcodi:locations:populate ES

This could take several minutes per country, be patient

3. Load and enable the template

Hey, we have some templates for you! Be sure to load 'em all!

    $ php app/console elcodi:templates:load
    $ php app/console elcodi:templates:enable StoreTemplateBundle

4. Load the plugins

Bamboo offers a bunch of plugins to customize your store. In the ecosystem of Bamboo, a Plugin is just a Bundle, so first of all, check that all the plugins you want to use are actually instantiated in you AppKernel class, under app/ folder.

To install load these plugins, use this command

    $ php app/console elcodi:plugins:load

5. Configure the store

When a store is created it's created "under construction", we can disable that mode from the command line. Otherwise, you will not be able to view your new awesome store.

    $ php app/console elcodi:configuration:set store.under_construction "0"
    $ php app/console elcodi:configuration:set store.name "\"My bamboo store\""

All configurations can be modified from the Admin settings panel

6. Run the server

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.

7. Visit your store

Yehaaa!! We're done! You're about to see what Elcodi can do for you. A complete store interface for your customers and some nice features for administrating it.

You can start using these credentials we've already created for you.

• Store: http://127.0.0.1:8000
  • Customer username: [e-mail]
  • Customer password: 1234
• Admin: http://127.0.0.1:8000/admin
  • Admin username: [e-mail]
  • Admin password: 1234

8. Play!

You can now play with the bamboo :) Don't forget to create an issue on Bamboo or Elcodi if you found any bug. Any collaboration is welcome! We look forward to hearing from you!

Tests

Yes, we are doing some tests, and this will be in cresciendo. You can ensure yourself that all the cases we've been working on are actually green. We are using Behat, so you only need to execute all Behat suites

   php bin/behat

Issues

You can report any issue on Bamboo or Elcodi

Need help

If you need any help with the installation or understanding elcodi or bamboo you can contact us on gitter. We will be glad of helping you, just ask for help.