d32bcbd602
Probably want to move to having my source in a src directory but that's not something I want to do at this time. Checking coverage in ./classes will skip over the pickles.php file (which I don't necessarily think needs tested) but also skips over the ./vendors directory which contains some third party stuff that doesn't have as much test coverage. |
||
|---|---|---|
| classes | ||
| tests | ||
| vendors | ||
| .coveralls.yml | ||
| .gitignore | ||
| .travis.yml | ||
| composer.json | ||
| composer.lock | ||
| LICENSE | ||
| pickles.php | ||
| 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 of your choice (nginx is highly recommended)
- PHP 5.5+
Please note that strides are being made to be compatible with bleeding edge technologies. PICKLES is currently developed against PHP 5.5 and does not pass build tests against prior versions. This effort will be with somewhat of a reckless abandon towards backwards compatibility to keep up with deprecations within PHP.
To help anyone that is “stuck” using PHP 5.3.x, the version distributed with Ubuntu 12.04 LTS, you can still use the 5.3 compatible branch available here instead. This branch is a fork of the master branch just before we started to these efforts and is considered very stable. The branch will remain available for the foreseeable future but will be indefinitely frozen unless pull requests are submitted.
As developers we make demands that our end users use modern day browsers while we’re just as guilty by running older server software, typically under the guise that it’s “stable”. I feel that we should be holding ourselves to the same standards when it comes to our server stacks. Stability is great, but at a certain point you’re sacrificing your own technology advancements as a developer as well as turning a blind eye to optimizations that can benefit your users.
Optional Software
- MySQL with PDO and PDO_MYSQL drivers
- PostgreSQL with PDO and PDO_PGSQL drivers
- SQLite 3 with PDO and PDO_SQLITE drivers
- Memcached with the Memcache module
- composer is you want to compile LESS, SCSS or JS also necessary if you want to run the unit tests
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.
- Download the PICKLES source code (or clone the repository)
- 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 - 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.
- At this point you should have a very rudimentary site up and running.
- Run
composer update