Skip to content
Parable is a PHP micro-framework, intended to just let you do your thing.
Branch: master
Clone or download
Latest commit 7f3bf35 Feb 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Merge pull request #50 from jerry1970/master Feb 26, 2019
structure Improvements to ORM and the default structure's config. Feb 4, 2018
tests When extracting parameters from the URL, the values are not trimmed s… Feb 23, 2019
.gitignore
.travis.yml
CHANGELOG-HISTORY.md
CHANGELOG.md
CONTRIBUTING.md Update CONTRIBUTING.md with design goals. Dec 10, 2017
LICENSE PR fixes suggested by @dmvdbrugge Jan 2, 2018
Makefile Add package system, fixups, update CHANGELOG later based on diff Mar 15, 2018
README.md Fix documentation link Feb 4, 2018
composer.json
dynamicReturnTypeMeta.json
parable
php-server.php
phpunit.xml

README.md

Parable PHP Framework

Build Status Latest Stable Version Latest Unstable Version License StyleCI

Parable is a PHP micro-framework intended to be readable, extensible and out-of-your-way.

Installation

Parable can be installed by using Composer.

$ composer require devvoh/parable

This will install Parable and all required dependencies. Parable requires PHP 5.6 or higher.

Simple Usage

Create an index.php file and include the composer autoloader:

<?php
require_once __DIR__ . '/vendor/autoload.php';

$app = \Parable\DI\Container::create(\Parable\Framework\App::class);

$app->get('/hello/{name}', function ($name) use ($app) {
    return "Hello, {$name}!";
});

$app->run();

Then go into the vendor/devvoh/parable directory and run make server. You can then open http://127.0.0.1:5678/hello/parable and you should be greeted by "Hello, parable!". You can also serve it through a regular webserver.

Advanced Usage

To use Parable for more than straightforward apps like in the Basic Usage above, and you want to use Controllers, Actions, Views and more, after installation, run the following command:

$ vendor/bin/parable init-structure

Now you're ready! Simply open the url it should be at in in your browser and you should see a welcome page.

If you want to use nginx or another server, that's cool too, but as of yet there's no example configuration available.

Getting Started

After you've run parable init-structure, you should have a basic structure to work from. The example files show most of what you'll need to build something. The example \Config\App file includes some of the most important things Parable itself will listen to.

Now, if you want to keep this out of your git (or other vcs) repository, you can place this in a separate config file and exclude it using a .gitignore file.

More information

Read the documentation for more detailed information on how to use Parable, and CHANGELOG.md for recent changes.

Contributing

Any help in improving Parable is much appreciated, but check CONTRIBUTING.md before creating any pull requests.

Contact

Any questions or constructive feedback? Find me at devvoh.com or ask me a question by adding an issue on github. I generally respond fairly quickly, since this is a passion project, after all.

License

Parable PHP Framework is open-sourced software licensed under the MIT license.

You can’t perform that action at this time.