Skip to content

Latest commit

 

History

History
126 lines (91 loc) · 3.91 KB

README.md

File metadata and controls

126 lines (91 loc) · 3.91 KB
Raw

This is Sample-App

Overview

This is a demo application using Kohana 3.3+ with REST, MongoDB, Backbone.js and Marionette.js. My goal is to learn how to use Marionette.js and MongoDB with a REST backend based on Kohana 3.3.

You can see a demo here: http://sampleapp.li/

Features

Here are some of the features brings by Sample-App :

  • Server side HMVC based on the Kohana framework
  • Client side MVC based on the Marionette.JS framework (which is based on Backbone)
  • Use public CDN and Require.JS to load Javascript and CSS
  • Use the full power of Twig to compose views and templates
  • Simple REST Api which could be extended to your purpose
  • Simple email service using SwiftMailer
  • Simple assets service to manage JS/CSS minification
  • Simple token service to give access to REST API (and more)
  • Simple queue service to delegate jobs to a real time backend (based on MongoDB)
  • Full server side and client side support of internationalization
  • Full integration of a simple account workflows (creation, deletion, password reset, etc.)
  • Responsive desing based on Bootstrap 3

With all of these features, your can quickly start to code a solid application based on standard composants.

Based on the demo application, you can use the HMVC pattern of Kohana to implement your own code into your own files without modifying a simple line of code of Sample-App, and keep upgrade simple.

Requirements

This application needs the following dependencies:

  • PHP 5.3, and PHP modules: cURL, iconv, mcrypt, mongodb
  • A HTTP server (like Apache or Lighttpd)
  • A local mail server which is allowed to send emails to Internet
  • A MongoDB server

Quick installation notes

Clone the repository, and init its dependencies:

$ git clone --recursive https://github.com/tchemineau/sample-app.git

On the system:

$ mkdir ./data/cache ./data/log
$ chown www-data:www-data ./data/cache ./data/log

Adjust your settings into the following files:

  • application/config/app.local.php
  • application/config/mongodb.local.php

This is a example of Lighttpd configuration:

$HTTP["host"] =~ "^example\.com$" {
    server.document-root = "/var/www/example.com/www/"
    server.name = "example.com"
    accesslog.filename = "/var/log/lighttpd/example.com.access.log"
    alias.url = (
        "/sample-app/assets/" => "/var/www/example.com/www/sample-app/data/cache/assets/",
        "/sample-app/" => "/var/www/example.com/www/sample-app/public/"
    )
    url.rewrite-if-not-file  = (
        "^/sample-app/(.+)" => "/sample-app/index.php/$1"
    )
    setenv.add-environment = (
        "KOHANA_ENV" => "production"
    )
}

Tests

Use PHPUnit to tests the project (tests are not yet written):

$ export KOHANA_ENV="testing"
$ phpunit --bootstrap=application/bootstrap.tests.php --group=sampleapp tests.php

All tests are stored into the modules/sampleapp/tests/ directory.

Thanks

This project uses the following components: