oanhnn/slim-skeleton

A skeleton for Slim framework

3.x-dev 2016-06-21 09:36 UTC

README

Build Status Latest Stable Version Total Downloads License

Join the chat at https://gitter.im/oanhnn/slim-skeleton

A skeleton for Slim Framework v3 following MVC pattern.

Main features

  • Support logging follow PSR-3 with Monolog
  • Support template engines: PHP view, Twig, Smarty, Plate, ... (default PHP view)
  • Support database accessing with Doctrine DBAL, CakePHP Database (support MySql, Postgresql, SQLite, ...)
  • Support many middlewares: Basic & Digest Authentication
  • Support making database test and integration test with PHPUnit
  • Support using gulp task to compile SASS, ES6, CoffeeScript, ...
Directories structure
path/to/project
|-- app
|   |-- assets
|   |-- config
|   |-- lang
|   `-- templates
|-- public
|-- src
|-- tests
|-- tmp
|   |-- cache
|   `-- logs
`-- vendor

Requirements

Usage

Create project

Using composer to create new project:

$ composer create-project oanhnn/slim-skeleton path/to/project --prefer-dist

Composer will create Slim project and all its dependencies under the path/to/project directory.

If you don't have Composer yet, download it following the instructions on http://getcomposer.org/ or just run the following command:

$ curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer
Run PHP build-in server

Run a build-in server on 0.0.0.0:8888

$ php -S 0.0.0.0:8888 -t public public/index.php

Open web browser with address http://localhost:8888

Run PHP Unit test
$ composer test
Build assets (css, js, ...) with gulp, npm
$ npm install
$ npm run-script build
Run task with gulp
$ node_modules/.bin/gulp <task>
Deploy project

To deploy a project using this skeleton, you can use Deployer.
See an example in here.

Changelog

See all change logs in CHANGELOG.md

Contributing

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send a pull request.

To ensure a consistent code base, you should make sure the code follows the PSR-2.

If you would like to help take a look at the list of issues.

License

This project is released under the MIT License.
Copyright © 2013-2016 Oanh Nguyen.
Please see License File for more information.