PHPackages                             web-masons/application-blueprint - 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. web-masons/application-blueprint

ActiveLibrary[Framework](/categories/framework)

web-masons/application-blueprint
================================

Cornerstone Application Blueprint

0.0.5(11y ago)014Apache-2.0PHPPHP >=5.4

Since Sep 23Pushed 11y ago1 watchersCompare

[ Source](https://github.com/web-masons/application-blueprint)[ Packagist](https://packagist.org/packages/web-masons/application-blueprint)[ Docs](https://github.com/web-masons/application-blueprint/)[ RSS](/packages/web-masons-application-blueprint/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (5)Dependencies (3)Versions (5)Used By (0)

ZF2 Application Blueprint
=========================

[](#zf2-application-blueprint)

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

[](#introduction)

This is a simple, application blueprint using the ZF2 MVC layer and module systems. This application is meant to be used as a starting place for those looking to develop new site or module on top of the Cornerstone base application.

This skeleton application can be used for developing new independent, composeable Module or it can be used to create a skeleton for a Site. In fact, every module you develop using Cornerstone should be a module and an independent site for testing.

The application skeleton has been separated from the Cornerstone module itself so that updates to the Cornerstone base application can be composed in without any need for manual merging. For instance if one of the built in Cornerstone routes changes, you simply run composer update and pull in the latest changes.

Requirements
------------

[](#requirements)

As noted in the composer file, this module requires Zend Framework 2.2 or higher. In addition, it requires `web-masons/Cornerstone`, though realistically any Module providing an "Application" would work. Though, if you were going to do that, you should probably just use the ZF2 Skeleton Application that already exists.

You will notice this project already has a Vagrant file and many Chef cookbooks available to make development easier. You don't need to use them, but you will likely want to.

Installation with Composer
--------------------------

[](#installation-with-composer)

The initial creation of a project should be done by performing a clone using composer; make sure to answer "Yes" when it prompts `Do you want to remove the existing VCS (.git, .svn..) history?`.

```
composer create-project -sstable web-masons/application-blueprint path/to/install

```

Generate a Configuration File
-----------------------------

[](#generate-a-configuration-file)

We include a base vagrant.json file to get you up and running quickly, but you will likely want to edit, and create your own config files. Create your config file in config/autoload/.json. Use the example\_environment.json.dist file as a base if needed.

Generate Your Virtual Host
--------------------------

[](#generate-your-virtual-host)

To generate a virtual host you need to run the packaged cli script. Note, this depends on the web-masons/Cornerstone module to run.

```
./php cornerstone.php application initialize --env=

```

Update the `module` Folder
--------------------------

[](#update-the-module-folder)

If you are creating a new module using this Application skeleton, simply rename the ApplicationBlueprint folder to match the name of your new module. Note, you will need to update various references to it throughout the code.

```
$ cd module/
$ mv ApplicationBlueprint NewModuleName

```

Namespace Updates for `Module.php` and `IndexController.php`

```
namespace ApplicationBlueprint;

```

becomes

```
namespace NewModuleName;

```

Update Configuration Files
--------------------------

[](#update-configuration-files)

### config/application.config.php

[](#configapplicationconfigphp)

Update the `$modules` array and change `ApplicationBlueprint` to your module name (e.g., NewModuleName).

```
$modules = array (
    'Application',
    'ApplicationBlueprint'
);
$application_config['modules'] = $modules;

```

becomes

```
$modules = array (
    'Application',
    'NewModuleName'
);
$application_config['modules'] = $modules;

```

### config/autoload/global.php

[](#configautoloadglobalphp)

Change the value of the `Region` key to match your module slug Change the value of the `Domain` key to match your domain

For example, when I test any of my modules I tend to set them up as:

```
return array (
    'Installation' => array (
        'Vhost' => array (
            'Server' => array (
                'Domain' => 'application-blueprint',
                'Region' => 'vagrant.www.'
            )
        )
    )
);

```

becomes

```
return array (
    'Installation' => array (
        'Vhost' => array (
            'Server' => array (
                'Domain' => 'oakensoul',
                'Region' => 'vagrant.module-name.'
            )
        )
    )
);

```

Or, update it to match your new sites region and domain:

```
return array (
    'Installation' => array (
        'Vhost' => array (
            'Server' => array (
                'Domain' => 'oakensoul',
                'Region' => 'www.'
            )
        )
    )
);

```

### module//config/module.config.php

[](#moduleconfigmoduleconfigphp)

#### Add routes

[](#add-routes)

Add any routes you would like as necessary. Check out the Cornerstone documentation for available routes to extend from as well as some built in values you can set to enforce the https scheme, set default theme and localization, etc.

#### Update Views (If Needed)

[](#update-views-if-needed)

You typically will not need to update the view data. If necessary, you would place your changes in this block:

```
$view_manager = array (
    'template_path_stack' => array (
        __DIR__ . '/../view'
    )
);

```

### module//Module.php

[](#modulemodulephp)

#### Update Invokables

[](#update-invokables)

```
$invokables['Application\Controller\Index'] = 'ApplicationBlueprint\Http\Controller\IndexController';

```

becomes

```
$invokables['Application\Controller\Index'] = 'NewModuleName\Http\Controller\IndexController';

```

Note: In the example, we are overloading the route Application\\Controller\\Index to resolve to our module's landing page. This can be helpful for testing modules that don't normally have controllers and routes, specifically libraries.

If you are going to use this method as I have with a few of my modules, make sure that your final "Site" module is the last to overload that Invokable. At the very least you can point it back at the Cornerstone index controller.

Add additional invokables and factories as necessary.

### Vagrantfile

[](#vagrantfile)

You will want to update the Vagrantfile if you are using Vagrant. You will need to update the vagrant-cornerstone "siteslug" and the servers hostname. You can find the spots you need to update by searching for vagrant.[www.application-blueprint](http://www.application-blueprint)

If you're running multiple hosts using Hostmanager, you may also need to update the IP address which you can find by searching for :ip

Update/Create Automated Tests
-----------------------------

[](#updatecreate-automated-tests)

All PHPUnit based tests are located under the `test/phpunit` directory with CasperJS tests located under the `test/caspserjs` directory. Update or create tests as you develop your module.

Documentation
-------------

[](#documentation)

Please update your module documentation, everyone loves great documentation!

Contributors
------------

[](#contributors)

Collaborators:

- [@Oakensoul](https://github.com/oakensoul)

Contributing
------------

[](#contributing)

- [Getting Started](doc/CONTRIBUTING.md)
- [Bug Reports](doc/CONTRIBUTING.md#bug-reports)
- [Feature Requests](doc/CONTRIBUTING.md#feature-requests)
- [Pull Requests](doc/CONTRIBUTING.md#pull-requests)

LICENSE
=======

[](#license)

This module is licensed using the Apache-2.0 License:

```
Copyright (c) 2013, Robert G. Johnson Jr. @Oakensoul and Project Contributors

```

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~86 days

Total

5

Last Release

4323d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/686caac2da1db66ed2fa3ca032f4dbd1f60cfe0e107f7e8c76f3819412c48496?d=identicon)[oakensoul](/maintainers/oakensoul)

---

Top Contributors

[![oakensoul](https://avatars.githubusercontent.com/u/2823850?v=4)](https://github.com/oakensoul "oakensoul (26 commits)")

---

Tags

frameworkzf2Skeletonoakensoul

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/web-masons-application-blueprint/health.svg)

```
[![Health](https://phpackages.com/badges/web-masons-application-blueprint/health.svg)](https://phpackages.com/packages/web-masons-application-blueprint)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)