joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/README.md
Josh Sherman f3f111fa22 Updated #3 to not display as a code block.
2011-04-17 13:43:49 -07:00

2.4 KiB
Raw Blame History

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

  • Apache (should run on 1.3+)
  • Apache Module mod_rewrite
  • PHP 5.0+

Highly Recommended Software

  • PHP 5.2.0+ for native JSON support or PECL JSON 1.2.1 (included)

Optional Software

  • MySQL with PDO and PDO_MYSQL drivers
  • PostgreSQL with PDO and PDO_PGSQL drivers
  • SQLite 3 with PDO and PDO_SQLITE drivers
  • Limited support for Mongo with Mongo driver and PECL Mongo 1.0.10 (included)

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. Open the boilerplate directory and you will find a sample site ready to be copied and pasted to wherever the site you set up is located.

    - The directory public will need to be renamed to whatever you've set up your document root as.

- The file apache.conf will give you some insight to how configure Apache, or you can just set the include path in public/index.php

  4. At this point you should have a very rudimentary site up and running.