Image Search Engine v1.2

It's All About Images

• Created: 04/17/2013
• latest Update: 04/17/2013
• By: Nick G.
• Email: gejadze@gmail.com

This documentation was made only with the Documenter (except the images)

Features

• - Flickr API integration
• - Filter results based on license
• - Sort by: Recent, Relevance or Interestingness
• - Caching system
• - jQuery Masonry templates
• - Fully configurable 

Requirement:

• LAMP server
• PHP >= 5.3
• NO DATABASE REQUIRED

Quick Start

Before uploading application to your webserver, obtain FLICKR API key at http://www.flickr.com/services/api/keys/apply/

Once you have API key, navigate to "Application\Config\" Directory and open up "'application.ini" file, 
at line 5 you will see:

flickrApiKey = ""

enter your key inside quotes so it looks like:

flickrApiKey = "your_key_here"

Save the file and we can get started uploading the application on your webserver.

Open up your favorite FTP program and connect to your server, in this example I will use FileZilla and Cpanel web hosting.

Select All files except 'Public' Directory and upload to Root Directory(parent directory of public_html).



Next Open up 'public_html' directory on your webserver and upload everything from 'Public' directory.

Open up website and application should work.

Advanced installation

if your webhosting structure does not allow you to put files on parent directory of publicly accessible directory, feel free to modify ./Public/index.php file to point to root directory of your application. 

Change:

define('ROOT', realpath(dirname(__FILE__)."/../"));
			

to:

define('ROOT', "/full/path_of/your/application/directory");
			

Next make "TMP" directory and all subdirectories writable (CHMOD 777).
and make sure .htaccess file is undex 'Public' directory.
feel free to rename 'Public' directory to 'public_html' or 'www' if needed.

Configuration

Configuration file is located at "Application/Config/application.ini".

Enter your facebook page URL or Website URL at line 8:

fblikeHref = "http://facebook.com/yourpage"
			

Enter amount of hashtags to show on homepage at line 11, hashtags are generated from keywords of background image.

numberOfTagsToShowOnHomepage = 7
			

Enable or disable API caching, make sure cacheDirectory is writable, cache time is in seconds

enableCache = true
cacheDirectory = "/TMP/FLICKR"
cacheTime = 3600
			

Feel free to change, add or remove keywords for background images

backgroundImage[]= "skyline"
backgroundImage[]= "photomatix"
...			

And enter your own serach suggestions:

searchSuggestion[]= "Try Search for 'Motion Blur'"
searchSuggestion[]= "Try Search for 'Macro Photography'"
...

File Structure

Layout:

Layout file located at

Application/Layout/Layout.html

this file is basically theme for the application, which is used across the pages.

Controllers:

Application controllers are located at  

Application/Controller/<name>Controller.php

Controllers identify what variables to set and pass to View

View:

View files are almost .html pages without php logic used inside. View file are located at:

Application/View/<ControllerName>/<Action_name>.phtml

Models:

Models are located under:

Application/Model/<modelName>.php 

Configuration:

Application/Config/<configName>.ini

route.ini is used to define and rewrite URL structure.
application.ini is used for everything else.

CSS, Javascript and Images:

All frontend assets and scripts are located under 'Public' Directory

Thank You