43 lines
2.8 KiB
Markdown
43 lines
2.8 KiB
Markdown
# PICKLES [](https://travis-ci.org/joshtronic/pickles) [](https://coveralls.io/r/joshtronic/pickles) [](https://www.versioneye.com/user/projects/52d1bc1eec13751bde00002a)
|
||
|
||
PICKLES (PHP Interface Collection of Killer Libraries to Enhance Stuff) is an open source framework for rapid PHP development. PICKLES aims to be an “API First” system for building APIs as well as AJAX/AJAJ-centric web applications.
|
||
|
||
## Requirements
|
||
|
||
### Required Software
|
||
|
||
* Web server of your choice (nginx is highly recommended but Apache with `mod_rewrite` will suffice)
|
||
* PHP 5.4+
|
||
|
||
Please note that PICKLES development is focused on the most recent stable version of PHP (currently 5.5) but will maintain backwards compatibility with the previous stable version. It may not be immediate, but when PHP 5.6 is released compatibility for PHP 5.4 will be dropped in favor of modern niceties.
|
||
|
||
For anyone stuck using PHP 5.3 is welcome to use [PICKLES v13.12.x](https://github.com/joshtronic/pickles/tree/v13.12.x) which at this time is still receiving bug fixes but will not be seeing any new development by myself. Pull requests are welcome.
|
||
|
||
My rant about outdated server stacks can be found [on my blog](http://joshtronic.com/2014/01/13/your-stack-is-outdated/#.UuVzI3n0A18).
|
||
|
||
### Optional Software
|
||
|
||
* MySQL server with the `PDO_MYSQL` driver
|
||
* PostgreSQL server with the `PDO_PGSQL` driver
|
||
* SQLite 3 with the `PDO_SQLITE` driver
|
||
* Memcached server with the `Memcache` module
|
||
* `composer` if you want to compile LESS, SCSS or JS also necessary if you want to use AYAH integration or run the test suite
|
||
* [ext/test_helpers](https://github.com/php-test-helpers/php-test-helpers) if you want to be able to run the test suite
|
||
|
||
## Installation
|
||
|
||
Installation is quite simple as there is no installer to run, and all server configuration options can be set in your index.php for your site.
|
||
|
||
1. [Download the PICKLES source](https://github.com/joshtronic/pickles/archive/master.zip) (or clone the repository)
|
||
2. Place the code anywhere you’d like (that’s at least 2 directories up from the root of your website). I recommend using `/usr/share/pickles[-vVERSION]`
|
||
3. Run `composer update`
|
||
4. A site already built in PICKLES can be found [here](https://github.com/gravityblvd/tools.gravityblvd.com)
|
||
|
||
## TODO
|
||
|
||
* Bring the project's Wiki up to date
|
||
* Build an actual boilerplate site that would be included in this project
|
||
|
||
## Thanks
|
||
|
||
Special thanks to [Geoff Oliver](https://github.com/geoffoliver) for being a long time user and contributor of PICKLES and to [Dean Jones](https://github.com/deanproxy) for coming up with the PICKLES acronym.
|