Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.31 KB

README.markdown

File metadata and controls

43 lines (28 loc) · 2.31 KB

Imbo - Image box

Imbo is an image "server" that can be used to add/get/delete images using a REST interface. There is also support for adding meta data to an image. The main idea behind Imbo is to have a place to store high quality original images and to use the REST interface to fetch variations of those images. Imbo will resize, rotate, crop (amongst other features) on the fly so you won't have to store all the different variations.

Current build Status

Documentation

End-user docs can be found here.

Community

Feel free to join #imbo on the Freenode IRC network (chat.freenode.net) if you have any questions.

Developer/Contributer notes

Here you will find some notes about how Imbo works internally along with information on what is needed to develop Imbo.

Get started

First you must make sure you have both PHPUnit and the Imagick extension installed. If not, you can install them using the following commands:

sudo pear config-set audo_discover 1
sudo pear install --alldeps pear.phpunit.de/PHPUnit
sudo apt-get install php5-imagick

Now click the fork button on github and then clone your fork:

git clone [email protected]:<username>/imbo.git

Enter the newly created directory and initialize the project using composer:

cd imbo
curl -s https://getcomposer.org/installer | php
php composer.phar --dev install

And lastly, execute the test suite:

phpunit

Some tests will probably be skipped unless you have already installed all optional dependencies, like APC, Memcached and Doctrine.

If you send me a pull request I would appreciate it if you include tests for all new code, and make sure that the test suite passes. I also require you to use "feature branches", also for minor fixes like typos in comments.