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
656 commits 6 branches 5 tags 17 MiB
Find a file
Josh Sherman 6b41edf659 Moved default cache expiration to 1 day 
Not quite ready to make the jump to no expiration, but 1 day has been serving me well for over a year now.
2013-09-15 12:38:32 -04:00
classes Moved default cache expiration to 1 day 2013-09-15 12:38:32 -04:00
tests/classes Tests for the Date class 2012-10-03 17:37:03 -04:00
vendors/google/closure-compiler Dropped modules, spruced up Dynamic class 2013-01-31 15:01:52 -05:00
.gitignore Gittin' my ignore on 2012-10-11 15:38:42 -04:00
MIT-LICENSE.txt Updated the last few URL's that were wrong, also generated a new copy of the documentation 2012-10-03 17:46:27 -04:00
pickles.php Got rid of the jar of PICKLES 2013-09-08 18:27:34 -04:00
README.md Update README.md 2013-02-04 21:01:21 -05:00

README.md

PHP Interface Collection of Killer Libraries to Enhance Stuff

What is PICKLES?

PICKLES is an open source framework for the rapid development of web applications.

Okay, but why?

I could have went with any number of existing frameworks, but I opted to build my own because I like to code. I've built quite a few sites from the ground up over the years, and I wanted to roll that experience into a single system that I could not only use for my sites, but share with the world.

Wait, what, it's not MVC?

PICKLES is in fact not a true MVC system and won't be masquerading around as one (yeah, I know, I borrowed some naming conventions). PICKLES does have a main controller that handles incoming page views. The controller loads a module that contains all of the business logic (optionally interacting with data models) and then execution is passed off to the display layer. The display layer gives the user what they asked for (even if they didn't say please). This is how web pages work, and there has never been a reason for me to force PICKLES into the MVC box just for the hell of it.

Requirements

Required Software

  • Web server (nginx or Apache with mod_rewrite)
  • PHP 5.3+

Please note that PICKLES can run on 5.0+ (you may need the PECL JSON library for versions below 5.2) but is heavily field tested on servers running the latest LTS release of Ubuntu (12.04 at the moment) running the latest stable version of PHP in the main repository (which is the 5.3.x branch). nginx is the preferred web server at this point, but PICKLES was deployed to and used on Apache 1.3+ for quite sometime.

Highly Recommended Software

  • PHP 5.2.0+ for native JSON support or PECL JSON 1.2.1

Optional Software

Databases

  • MySQL with PDO and PDO_MYSQL drivers
  • PostgreSQL with PDO and PDO_PGSQL drivers
  • SQLite 3 with PDO and PDO_SQLITE drivers

CSS Pre-processors

  • node, npm & lessc to compile LESS files
  • sass to compile SASS files

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 source http://github.com/joshtronic/pickles/zipball/master (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
  3. A starter site can be obtained from http://github.com/joshtronic/pickles-starter. It has everything you need to get a site up and running.
  4. At this point you should have a very rudimentary site up and running.