carbontwelve/slim-skeleton

An opinionated slim skeleton

0.0.4 2016-06-02 12:33 UTC

Requires

• php: >=5.5.9
• aura/session: ^2.0
• carbontwelve/slim-plates: ^0.0.1
• monolog/monolog: ^1.17
• slim/slim: ^3.1

Requires (Dev)

• symfony/var-dumper: ^3.0
• zeuxisoo/slim-whoops: 0.5.*

MIT

• Simon Dann

• framework
• mvc
• slim
• slim-starter

README

A rather opinionated skeleton project for getting started with your slim applications. It is heavily inspired by Laravels directory structure, so if you have used Laravel 5 you should feel familiar with this.

Getting started

The easiest method for getting started developing with the Slim3 Skeleton is via the composer create-project command: composer create-project -s dev --prefer-dist carbontwelve/slim-skeleton app

Using npm install will pull in all the node requirements for the gulpfile to run, the gulpfile has serveral helper methods for building js and css from the resource folder as well as a file watcher to build on demand while you code.

Development

Once installed you can use the built in php server with the serve.php helper to run the app in your browser: php -S 127.0.0.1:8080 -t public serve.php

Basic page "router" usage

The Slim Skeleton extends the Slim3 \Slim\Handlers\NotFound handler class with App\Http\Handlers\NotFoundPageResolver which checks to see if the uri path can be resolved to a view inside the path resources\views\pages.

It will first check to see if the uri path is a directory and if so then check to see if there is a index.phtml within it; this means that http://example.com/item-one/item-two will first attempt to resolve to resources\views\pages\item-one\item-two\index.phtml.

If the first check fails it will then see if the view file exists directly, in the case of the previous example it would then attempt to resolve to resources\views\pages\item-one\item-two.phtml.

If both checks fail it passes through to the default Slim3 renderHtmlNotFoundOutput method.

With this simple functionality you can build quite complex websites without having to configure any granular routes!

Roadmap

I found myself needing a simple, yet opinionated, skeleton project to build out other applications using Slim3. For larger projects I tend to go for Laravel5 and so the folder structure is heavily inspired by that framework.