bandama/app-lite

Bandama Application Skeleton with Monolog and Kahlan

Bandama Application Lite Skeleton

Bandama App Lite is a skeleton project for Bandama Framework that includes Monolog for logging and Kahlan for unit tests., _(*1)

Create a new project

It's recommended that you use Composer to create project., _(*2)

$ composer create-project --no-interaction bandama/app-lite [project-name]

This will create new Bandama project and all required dependencies including Bandama Framework, Monolog and Kahlan. Bandama Project requires PHP 5.5 or newer., _(*3)

Run the project

Got to the root directory of your project and run it typing, _(*4)

$ cd [project-name]
$ php -S localhost:8008 -t web web/app.php

Browse to http://localhost:8008, _(*5)

Project structure

• app, _(*6)

  This folder contains globals elements of application. It contains App and Configuration classes., _(*7)

  • core, _(*8)

    This folder contains App, Configuration and Controller classes which implements base application logic, _(*9)

  • App.php : This class allow to extend and customize application logic, _(*10)
  • Configuration.php : Class allowing customization of application configuration parameters
  • Controller.php : Base application controller class

  • config, _(*11)

    Config folder contains configuration parameters splitted in many files:, _(*12)

    • databases.php : Collection of databases configuration
    • parameters.php : Application base parameters
    • routes.php : Contains routes definition
    • services.php : Services used by application
    • sessions.php : User sessions parameters
    • settings.php : Merging of other configuration files

• spec, _(*13)

  Contains unit tests for project, _(*14)

• src, _(*15)

  Project source code, _(*16)

  • controllers, _(*17)

    Controllers classes, _(*18)

  • models, _(*19)

    Project models for interacting with databases and other sources of data, _(*20)

  • views, _(*21)

    Contains views, _(*22)

  • services, _(*23)

    Application services, _(*24)

• var, _(*25)

  • logs, _(*26)

    Log files, _(*27)

• vendor, _(*28)

  Contains third party library, including Bandama Framework, Monolog and Kahlan, _(*29)

• web, _(*30)

  This folder contains public files, _(*31)

  • app.php : Application entry point

  It is the entry point of application, _(*32)

  • assets, _(*33)

    • css
    • images
    • js

  • data, _(*34)

    Contains another assets and data, _(*35)

  • plugins, _(*36)

    Contains plugins used in project e.g (bootstrap, jquery, etc.), _(*37)

Change log

• 1.2.0
  • Adding translator component
  • Using Kahlan for unit tests
• 1.1.1
  • Bug fixed - Removing index.php file in .gitignore

• 1.1.0, _(*38)

  • Improvement of application setup
  • Adding HelloServiceTest class
  • Adding basic layout content
  • Adding PDO Session Handler management

• 1.0.1, _(*39)

  • Bug fixed in .htaccess

Credits

• Jean-François YOBOUE

License

The Bandama Framework Skeleton is licensed under the MIT license. See License File for more information., _(*40)