canteen / framework
PHP site framework for building JSON-driven, stateless websites built on Flight PHP
Requires
- php: >=5.4.0
- canteen/database: *
- canteen/events: *
- canteen/html5: *
- canteen/parser: *
- mikecao/flight: *
This package is not auto-updated.
Last update: 2020-01-20 03:36:52 UTC
README
#Canteen Framework
Small PHP framework for building JSON-driven, stateless websites. For documentation of the codebase, please see Canteen Framework docs.
##Usage
For an example of usage please see the Canteen Boilerplate project.
##Installation
Install is available using Composer.
composer require canteen/framework dev-master
###Contents of index.php
// Include the Composer autoloader require 'vendor/autoload.php'; // Create a new Canteen Site $site = new Canteen\Site(); // Render the page $site->render();
###Rebuild Documentation
This library is auto-documented using YUIDoc. To install YUIDoc, run sudo npm install yuidocjs
. Also, this requires the project CanteenTheme be checked-out along-side this repository. To rebuild the docs, run the ant task from the command-line.
ant docs
##License##
Copyright (c) 2013 Matt Karl
Released under the MIT License.