README

Fast. Easy. Clean. RESTful

How it looks

The most basic example is including the routing module and defining a few endpoints and providing a callback function that executes when someone requests that page.

Epi::init('route');
getRoute()->get('/', 'home');
getRoute()->get('/contact', 'contactUs');
getRoute()->run();

function home() {
    echo 'You are at the home page';
}

function contactUs() {
    echo 'Send us an email at <a href="mailto:foo@bar.com">foo@bar.com</a>';
}

Learn more about the modules

Read documentation on the individual modules available in Epiphany.

1. Route - A RESTful routing library to map paths to functions.
2. Api - An API helper module to create private and public APIs. This is both new and awesome.
3. Session - A multi-engine session library which supports native PHP sessions, APC and Memcached.
4. Database - A simple interface to PDO's MySql driver.
5. Cache - A easy caching library which supports APC and Memcached.
6. Config - An ini based configuration library that supports overloading.

The Manifesto

The Epiphany framework is fast, easy, clean and RESTful. The framework does not do a lot of magic under the hood. It is, by design, very simple and very powerful.

The documentation provides a few conventions that we believe lead to well written code but you're free to use any style you'd like. The framework never dictates how you should write or structure your application.

What you need

The Epiphany framework only requires PHP 5+, Apache and mod_rewrite. That's all!

Getting started

The following links to documentation and articles will help you get up and running in no time. Included in the repository is an example directory with sub applications highlighting the different features of the Epiphany framework.

1. http://github.com/jmathai/epiphany

The authors

Get in touch with the authors if you have suggestions or questions.

	Jaisen Mathai jaisen-at-jmathai.com http://www.jaisenmathai.com
	Kevin Hornschemeier khornschemeier-at-gmail.com http://www.khornschemeier.com