ryu22e/slim-skeleton-phpunit

A Slim Framework skeleton application for rapid development

0.0.1 2015-01-31 05:39 UTC

This package is not auto-updated.

Last update: 2024-04-23 14:26:15 UTC


README

Use this skeleton application to quickly setup and start working on a new Slim Framework application. This application uses the latest Slim and Slim-Views repositories. It also uses Sensio Labs' Twig template library.

This skeleton application was built for Composer. This makes setting up a new Slim Framework application quick and easy.

Install Composer

If you have not installed Composer, do that now. I prefer to install Composer globally in /usr/local/bin, but you may also install Composer locally in your current working directory. For this tutorial, I assume you have installed Composer locally.

http://getcomposer.org/doc/00-intro.md#installation

Install the Application

After you install Composer, run this command from the directory in which you want to install your new Slim Framework application.

php composer.phar create-project ryu22e/slim-skeleton-phpunit [my-app-name]

Replace [my-app-name] with the desired directory name for your new application. You'll want to:

  • Point your virtual host document root to your new application's public/ directory.
  • Ensure logs/ and templates/cache are web writeable.

That's it! Now go build something cool.

How to test

After install the application, run this command from the directory.

make test

Test codes are in tests/.

How to Contribute

Pull Requests

  1. Fork the Slim Skeleton repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the develop branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows us to review and pull in new features or improvements individually.

Style Guide

All pull requests must adhere to the PSR-2 standard.