joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
Pickles is a PHP framework for building kick-ass services. http://picklesphp.com
828 commits 6 branches 5 tags 17 MiB
Find a file
Joshua Sherman ddf1719862 Reworked the README a bit
2014-01-26 15:52:31 -05:00
src Fixed issue with UTF-8 2-byte characters 2014-01-26 15:09:16 -05:00
tests Fixed issue with UTF-8 2-byte characters 2014-01-26 15:09:16 -05:00
.coveralls.yml Rehooking up coveralls 2014-01-20 23:58:32 -05:00
.gitignore Working towards standard directory names 2014-01-20 22:23:04 -05:00
.travis.yml Changed build/log directory 2014-01-21 21:51:59 -05:00
composer.json Added package details to json file 2014-01-20 23:44:51 -05:00
composer.lock Added package details to json file 2014-01-20 23:44:51 -05:00
LICENSE Updated copyright date. 2014-01-05 13:44:25 -05:00
README.md Reworked the README a bit 2014-01-26 15:52:31 -05:00

README.md

PICKLES

Build Status Coverage Status Dependency Status

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 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.

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 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 (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

TODO

  • Bring the project's Wiki up to date
  • Build an actual boilerplate site that would be included in this project

Thanks

Special thanks goes out to @deanproxy for helping to name this project and @geoffoliver for being a long time user and contributor of this project.