PHPackages                             aura/system - 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. aura/system

ActiveProject[Framework](/categories/framework)

aura/system
===========

A full-stack framework system built from Aura library packages.

1.0.1(11y ago)621.2k11BSD-2-ClausePHP

Since Sep 18Pushed 11y ago8 watchersCompare

[ Source](https://github.com/auraphp/system)[ Packagist](https://packagist.org/packages/aura/system)[ RSS](/packages/aura-system/feed)WikiDiscussions develop Synced 4w ago

READMEChangelogDependencies (18)Versions (4)Used By (0)

Aura System
===========

[](#aura-system)

[![Build Status](https://camo.githubusercontent.com/6a80ed5e036f6e4813fdc1641bdf7e05c46b41df07f599a87f7c0b066c501a47/68747470733a2f2f7472617669732d63692e6f72672f617572617068702f73797374656d2e706e673f6272616e63683d646576656c6f70)](https://travis-ci.org/auraphp/system)

The Aura System provides a full-stack Aura framework built around Aura library packages.

Getting Started
---------------

[](#getting-started)

### Installation

[](#installation)

Install via [Composer](http://getcomposer.org) to a `{$PROJECT_PATH}` of your choosing:

```
composer create-project aura/system {$PROJECT_PATH}

```

This will create the system skeleton and install all of the necessary packages.

Once you have installed the Aura system, start the built-in PHP server with an Aura.Framework command:

```
cd {$PROJECT_PATH}
php package/Aura.Framework/cli/server

```

You can then open a browser and go to  to see the "Hello World!" demo output.

Press `Ctrl-C` to stop the built-in PHP server.

Additionally, you can run a command-line test:

```
cd {$PROJECT_PATH}
php package/Aura.Framework_Demo/cli/hello

```

You should see "Hello World!" as the output.

### Run The Tests

[](#run-the-tests)

For testing, you need to have [PHPUnit 3.7](http://www.phpunit.de/manual/current/en/) or later installed.

To run the integration tests for the system as a whole, change to the `tests`directory and issue `phpunit`:

```
cd {$PROJECT_PATH}/tests
phpunit

```

To run the unit tests for a package, change to that package's `tests`directory and issue `phpunit`:

```
cd {$PROJECT_PATH}/package/Aura.Autoload/tests
phpunit

```

### Web Server

[](#web-server)

To run Aura under Apache or another web server, add a virtual host to your web server configuration, then point its document root to `{$PROJECT_PATH}/web`.

If `mod_rewrite` or an equivalent module is installed on the server, you will be able to browse without needing `index.php` in the URL.

### Remove the Demo Package

[](#remove-the-demo-package)

When you are satisifed that the installation is working, edit the `composer.json` file to remove the `aura/framework-demo` package requirement and then run `composer update`.

System Organization
-------------------

[](#system-organization)

The system directory structure is pretty straightforward:

```
{$PROJECT_PATH}/
    config/                     # mode-specific config files
        _mode                   # the config mode to use
        _packages               # load these packages in order
        default.php             # default config
        dev.php                 # shared development server config
        local.php               # local development server config
        prod.php                # production config
        stage.php               # staging config
        test.php                # testing config
    include/                    # application include-path directory
    package/                    # aura-package libraries
    tests/                      # system tests
    tmp/                        # temporary files
    vendor/                     # composer vendors
    web/                        # web server document root
        .htaccess               # mod_rewrite rules
        cache/                  # public cached files
        favicon.ico             # favicon to reduce error_log lines
        index.php               # bootstrap script

```

Writing A Page Controller
-------------------------

[](#writing-a-page-controller)

Let's create a package and a page controller, and wire it up for browsing. We will do so in a project-specific way, leaving out the complexities of creating an independent package for distribution.

> Warning: If you have not removed the `Framework_Demo` package yet, please [do so](#remove-the-demo-package) before continuing. Otherwise, your routes will not work correctly.

### Create The Controller

[](#create-the-controller)

Change to the `include/` directory and create a location for the example package and a space for our first web page ...

```
cd {$PROJECT_PATH}/include
mkdir -p Example/Package/Web/Home
cd Example/Package/Web/Home

```

... then create a file called `HomePage.php`. Add this code for a bare-bones index action:

```

```

### Create The View

[](#create-the-view)

Next, create a view for the index action in a file called `views/index.php`and add the following code to it

```

```

At this point your `include/` directory should look like this:

```
include/
    Example
        Package/
            Web/
                Home/
                    HomePage.php
                    views/
                        index.php

```

> N.b.: Technically you don't need a directory structure this deep. However, a structure like this makes it easy to add new pages as well as other support libraries without having to change the project organization later.

### Configure The System

[](#configure-the-system)

Now we need to wire up the page controller to the autoloader and the routing system. Change to the system config directory:

```
$ cd {$PROJECT_PATH}/config

```

Edit the `default.php` file and add this code at the end of the file:

```

```

### Try It Out

[](#try-it-out)

You should now be able to browse to the `/` URL to see "This is an example home page."

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 66.7% 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 ~552 days

Total

2

Last Release

4117d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/25754?v=4)[Paul M. Jones](/maintainers/pmjones)[@pmjones](https://github.com/pmjones)

![](https://www.gravatar.com/avatar/29dba0e6add8d89fd3fc6126b213d5d2f57538ea78318963025d6ea98db34161?d=identicon)[harikt](/maintainers/harikt)

---

Top Contributors

[![harikt](https://avatars.githubusercontent.com/u/120454?v=4)](https://github.com/harikt "harikt (10 commits)")[![AmyStephen](https://avatars.githubusercontent.com/u/95525?v=4)](https://github.com/AmyStephen "AmyStephen (1 commits)")[![arisk](https://avatars.githubusercontent.com/u/1027859?v=4)](https://github.com/arisk "arisk (1 commits)")[![galactic-void](https://avatars.githubusercontent.com/u/40361?v=4)](https://github.com/galactic-void "galactic-void (1 commits)")[![Green-Cat](https://avatars.githubusercontent.com/u/3328823?v=4)](https://github.com/Green-Cat "Green-Cat (1 commits)")[![pborreli](https://avatars.githubusercontent.com/u/77759?v=4)](https://github.com/pborreli "pborreli (1 commits)")

---

Tags

deprecatedframeworksystemauraauraphp

### Embed Badge

![Health badge](/badges/aura-system/health.svg)

```
[![Health](https://phpackages.com/badges/aura-system/health.svg)](https://phpackages.com/packages/aura-system)
```

###  Alternatives

[aura/framework

The Aura Framework package, when combined with a system skeleton, provides a full-stack framework built from Aura component packages.

9912.3k3](/packages/aura-framework)[bear/package

BEAR.Sunday application framework package

31566.2k27](/packages/bear-package)[utopia-php/system

A simple library for obtaining information about the host's system.

25316.9k29](/packages/utopia-php-system)

PHPackages © 2026

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