PHPackages                             etenil/assegai - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. etenil/assegai

ActiveLibrary[Framework](/categories/framework)

etenil/assegai
==============

A full MVC framework for PHP.

v2.2.9(10y ago)86.0k5[9 issues](https://github.com/Etenil/assegai/issues)[1 PRs](https://github.com/Etenil/assegai/pulls)MITPHP

Since Jan 13Pushed 7y ago1 watchersCompare

[ Source](https://github.com/Etenil/assegai)[ Packagist](https://packagist.org/packages/etenil/assegai)[ Docs](http://github.com/Etenil/atlatl)[ RSS](/packages/etenil-assegai/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependenciesVersions (36)Used By (0)

ASSEGAI
=======

[](#assegai)

UPDATED 03 August 2014

Introduction
------------

[](#introduction)

Assegai is a full-featured MVC framework for PHP. It is free software under the MIT license.

The framework used to rely on the micro-framework [Atlatl](http://github.com/Etenil/atlatl). This dependency was dropped in version 2.0.

Installation
------------

[](#installation)

*Note: A full demonstration video is available illustrating points covered in the installation and the getting started sections. Please visit [youtube](https://www.youtube.com/watch?v=c3jxjB5p99E) to view the video.*

To install Assegai you will first need to install [composer](http://getcomposer.org). Then create a composer.json file for your project that requires *etenil/assegai*. An example composer.json file should look as following:

```
{
    "name": “YOUR_NAME/helloworld”,
    "require": {
        "etenil/assegai": "2.*"
    }
}
```

Now save and exit the composer.json file and from your project’s root folder (using command line) run the following command:

```
$ composer install

```

Once the installation of Assegai is completed, you will have a fully functional MVC framework installed inside your project's folder.

Getting started
---------------

[](#getting-started)

There are many possible ways to setup and use the Assegai framework. Following sections demonstrates currently the most simple setup. The recommended setup documentation will follow shortly.

### Bootstrapping

[](#bootstrapping)

You will need to make a bootstrapper or use the default one for your project. The framework comes with an example bootstrapper that you can adapt.

To utilise the default bootstrapper run the following command from within your project’s root folder:

```
$ cp vendor/etenil/assegai/bootstrapper.example.php index.php

```

This will copy the already provided example bootstrapper file into the project’s root folder, renaming the file to *index.php*.

### Basic Configuration

[](#basic-configuration)

Even though Assegai has default configuration options, it will not work unless a configuration file is created, even if empty. You can simply use the file *conf.example.php* that comes with the framework. To do that from your project root folder use the following command:

```
$ cp vendor/etenil/assegai/conf.example.php conf.php

```

Now you have fully configured framework. In order to test the setup the flowing section will demonstrate how to create an application with Assegai.

### Hello World app

[](#hello-world-app)

In this chapter, we'll see how to write a very simple application for assegai, it will simply display the famous "Hello, World" message on an HTML page.

To create application firstly go into the conf.php file in your projects’s root folder and add the application name into the apps array. Feel free to delete or simply rename the currently existing sample app.

Your configuration file should look as following:

```