kernelk14/aura

AuraPHP - Lightweight PHP MVC Framework with OwnStrap CSS

Maintainers

Package info

github.com/kernelk14/aura

Type:project

pkg:composer/kernelk14/aura

Statistics

Installs: 22

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v1.0.15 2026-06-06 02:15 UTC

Requires

  • php: >=7.4

MIT 58afde559a0f419969c27f1692db5930350d4514

This package is auto-updated.

Last update: 2026-06-06 02:16:36 UTC

README

PHP 7.4+ Version 1.0 Size ~150KB MIT License

AuraPHP is a lightweight PHP MVC framework designed for rapid web application development. It ships with OwnStrap, a custom CSS/JS framework providing 300+ utility classes and 10+ interactive components — no external dependencies required.

  • Size: ~150KB total (framework + CSS + JS + fonts)
  • PHP: 7.4+
  • License: MIT

Table of Contents

Installation

Via Composer

composer create-project kernelk14/aura my-app
cd my-app
php aura serve

Manual

Clone the repository and point your web server to the project root:

git clone https://github.com/kernelk14/aura.git
cd auraphp
php aura serve

Requirements

Requirement Version
PHP >= 7.4
Web Server Apache (mod_rewrite), Nginx, or PHP built-in
Database (optional) MySQL, PostgreSQL, or SQLite
Composer (optional) For dependency management

Quick Start

1. Start the dev server

php aura serve
# Opens at http://127.0.0.1:8080

2. Configure

Edit system/config/config.php:

return [
    'base_url' => 'http://localhost:8080',
];

3. Define a route

// system/config/routes.php
$router->get('hello', 'hello@index');

4. Create a controller

// site/controllers/hello.php
namespace SiteControllers;

use AuraCore\Controller;

class Hello extends Controller
{
    public function index()
    {
        $this->loadView('hello', [
            'title' => 'Hello World',
        ]);
    }
}

5. Create a view

<div class="container mt-5 text-center">
    <h1 class="text-gradient-success"><?= htmlspecialchars($title) ?></h1>
    <p class="lead">Welcome to AuraPHP.</p>
</div>

Views are pure content — no HTML shell needed. The template layout (DOCTYPE, <html>, <head>, <body>, navbar, JS) wraps around your view automatically.

The aura CLI Tool

AuraPHP includes a powerful command-line tool inspired by Laravel Artisan and Spiral Spark.

php aura list

Server & Dev

Command Description
php aura serve Start the PHP development server
php aura serve --port=3000 --host=0.0.0.0 Start on custom host/port

Generators

Command Description
php aura make:controller <name> Generate a controller
php aura make:controller <name> --resource Generate a resource controller (7 REST methods)
php aura make:model <name> Generate a model
php aura make:migration <name> Generate a migration
php aura make:seeder <name> Generate a database seeder
php aura make:view <name> Generate a view
php aura make:middleware <name> Generate middleware
php aura make:event <name> Generate an event class
php aura make:listener <name> Generate an event listener
php aura make:request <name> Generate a form request / validation class
php aura make:rule <name> Generate a custom validation rule
php aura make:scope <name> Generate a model global scope
php aura make:helper <name> Generate a helper file
php aura make:command <name> Generate a custom CLI command
php aura make:provider <name> Generate a service provider

All generators accept --force to overwrite existing files.

Database

Command Description
php aura migrate Run all pending migrations
php aura migrate:rollback Rollback the last migration batch
php aura migrate:status Show migration status
php aura migrate:fresh Drop all tables and re-run all migrations
php aura migrate:reset Rollback all migrations
php aura migrate:refresh Rollback all and re-run all migrations
php aura db:seed Run all database seeders
php aura db:seed --class=UserSeeder Run a specific seeder
php aura db:wipe Drop all tables

Utilities

Command Description
php aura route:list Display all registered routes
php aura key:generate Generate an application encryption key
php aura about Show framework information and application stats
php aura inspire Show an inspiring quote
php aura list List all available commands

Examples

# Start development server on custom port
php aura serve --port=3000 --host=0.0.0.0

# Generate a resource controller with 7 REST methods
php aura make:controller Product --resource

# Generate a model with CRUD methods
php aura make:model User

# List all routes with methods and handlers
php aura route:list

# Run a specific seeder
php aura db:seed --class=UserSeeder

# Show framework info
php aura about

# See framework version
php aura --version

Project Structure

my-app/
├── aura                         # CLI tool (1,842-line single-file PHP)
├── composer.json                # PSR-4 autoload + bin + scripts
├── package.json                 # Frontend tooling metadata
├── package-lock.json
├── .htaccess                    # Apache rewrite → index.php
├── .gitignore
├── index.php                    # Front controller (161 lines)
├── public/                      # Web-accessible assets
│   ├── css/
│   │   ├── ownstrap.css         # Main CSS framework (3,443 lines)
│   │   ├── ownstrap-colors.css  # Color palette (674 lines)
│   │   └── fonts/               # Fira_Sans/ + Inter/ + JetBrainsMono/
│   └── js/
│       └── ownstrap.js          # OwnStrap JS class (1,152 lines)
├── system/                      # Framework core (don't edit)
│   ├── core/                    # 25 AuraCore\ classes
│   ├── config/                  # Edit these
│   │   ├── config.php
│   │   ├── database.php
│   │   └── routes.php
│   ├── helpers/
│   │   └── url_helper.php
│   └── installer-needs/
│       └── PostInstall.php
├── site/                        # Your application (M, V, C)
│   ├── controllers/             # SiteControllers\
│   ├── models/                  # SiteModels\
│   ├── views/                   # Plain PHP templates
│   ├── templates/               # Reusable partials
│   ├── events/                  # SiteEvents\
│   ├── listeners/               # SiteListeners\
│   ├── middleware/              # SiteMiddleware\
│   ├── requests/                # SiteRequests\
│   ├── rules/                   # SiteRules\
│   ├── scopes/                  # SiteScopes\
│   ├── commands/                # SiteCommands\
│   ├── providers/               # SiteProviders\
│   └── pages/management/        # Built-in admin UI (8 pages)
└── storage/
    └── logs/                    # Logger writes YYYY-MM-DD.log files

Note: This project has zero Composer runtime dependencies — there's no vendor/ directory. composer.json exists only to register the PSR-4 autoloader and the aura bin entry. A .env file is auto-created on first run via php aura key:generate.

Routing

Routes are defined in system/config/routes.php. The router supports GET, POST, PUT, DELETE, and wildcard (any) methods.

Basic routes

$router->get('/', 'welcome@index');
$router->get('about', 'page@about');
$router->post('contact', 'contact@store');
$router->put('users/:id', 'user@update');
$router->delete('users/:id', 'user@destroy');
$router->any('webhook', 'webhook@handle');

Route parameters

Use :param syntax. Parameters are passed as positional arguments to the controller method:

// Route
$router->get('blog/:id/:slug', 'blog@show');

// Controller method receives $id and $slug
class Blog extends Controller {
    public function show($id, $slug) {
        echo "Post #{$id}: {$slug}";
    }
}

Callback handlers

You can also use closures directly:

$router->get('api/time', function() {
    echo json_encode(['time' => date('Y-m-d H:i:s')]);
});

Route listing

php aura route:list

Output:

Method  Path                                    Handler
────────────────────────────────────────────────────────────────────────────────
GET     /                                       welcome@index
GET     /welcome                                welcome@index
GET     /components                             components@index
GET     /demo/user/:id                          demo@user

Controllers

Controllers live in site/controllers/ and extend AuraCore\Controller.

Naming conventions

Item Convention Example
File name Lowercase kebab user-profile.php
Class name PascalCase UserProfile
Namespace SiteControllers SiteControllers\UserProfile
Route handler file@method user-profile@index

Example controller

<?php
// site/controllers/user-profile.php

namespace SiteControllers;

use AuraCore\Controller;

class UserProfile extends Controller
{
    public function index()
    {
        $data = [
            'title' => 'User Profiles',
            'users' => ['Alice', 'Bob', 'Carol'],
        ];
        $this->loadView('user-profile', $data);
    }

    public function show($id)
    {
        $db = $this->loadDatabase();
        $user = $db->getWhere('users', ['id' => $id]);

        $this->loadView('user-profile/show', [
            'title' => 'User Details',
            'user' => $user,
        ]);
    }
}

Controller methods

Method Description
$this->loadView('name', $data) Load a view with extracted data
$this->loadModel('user_model') Load a model instance
$this->loadDatabase($group) Load a database connection
$this->redirect('url') Redirect to a URL
$this->config('item') Get a configuration value

Generating controllers

# Simple controller
php aura make:controller UserProfile

# Resource controller (7 RESTful methods)
php aura make:controller Product --resource

The --resource flag generates: index(), create(), store(), show($id), edit($id), update($id), destroy($id).

Views

Views are plain PHP files in site/views/. They receive data as extracted variables.

Template pattern

Views are pure content — no HTML shell needed. The layout (template.php) automatically wraps your view:

<div class="container mt-5">
    <h1><?= htmlspecialchars($title) ?></h1>
    <p><?= htmlspecialchars($message) ?></p>
</div>

The layout provides the DOCTYPE, <html>, <head> (with ownstrap_css()), <body> with navbar, and ownstrap_js() before the closing </body> tag. Your view only needs the middle content.

To skip the layout (e.g. for standalone pages), pass false as the third argument:

$this->loadView('welcome', $data, false);

Passing data

Controllers pass data as an associative array:

// Controller
$this->loadView('user-profile', [
    'title' => 'User Profile',
    'user' => ['name' => 'Alice', 'email' => 'alice@example.com'],
]);

The view receives $title and $user as variables:

<h1><?= htmlspecialchars($title) ?></h1>
<p><?= htmlspecialchars($user['name']) ?></p>

Helper functions available in views

Function Description
<?php ownstrap_css() ?> Outputs CSS <link> tags
<?php ownstrap_js() ?> Outputs JS <script> tag
<?= site_url('path') ?> Full URL to a path
<?= base_url('path') ?> Base URL with path
<?php template('name') ?> Include a template partial from site/templates/

Reusable template partials

Place shared view fragments in site/templates/ and include them with the template() helper:

<?php template('sidebar-framework') ?>   <!-- includes site/templates/sidebar-framework.php -->

This keeps views DRY — useful for sidebars, footers, navs, or any repeated markup.

Models

Models go in site/models/ and extend AuraCore\Model.

<?php
// site/models/user_model.php

use AuraCore\Model;

class User_Model extends Model
{
    private $table = 'users';

    public function getAll()
    {
        $db = $this->loadDatabase();
        return $db->get($this->table);
    }

    public function getById($id)
    {
        $db = $this->loadDatabase();
        return $db->getWhere($this->table, ['id' => $id]);
    }

    public function create($data)
    {
        $db = $this->loadDatabase();
        return $db->insert($this->table, $data);
    }

    public function update($id, $data)
    {
        $db = $this->loadDatabase();
        return $db->update($this->table, $data, ['id' => $id]);
    }

    public function delete($id)
    {
        $db = $this->loadDatabase();
        return $db->delete($this->table, ['id' => $id]);
    }
}

Usage in a controller:

$userModel = $this->loadModel('user_model');
$users = $userModel->getAll();

Generating models

php aura make:model User

Migrations

Migrations are version-controlled database schema changes stored in site/migrations/.

Creating a migration

php aura make:migration create_users_table

This generates a timestamped file like 2025_01_15_120000_create_users_table.php:

<?php

use AuraCore\Database;

return new class
{
    public function up(Database $db)
    {
        $db->query("CREATE TABLE users (
            id INT AUTO_INCREMENT PRIMARY KEY,
            name VARCHAR(255) NOT NULL,
            email VARCHAR(255) NOT NULL UNIQUE,
            created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
        )");
    }

    public function down(Database $db)
    {
        $db->query("DROP TABLE IF EXISTS users");
    }
};

Running migrations

# Run pending migrations
php aura migrate

# Rollback the last batch
php aura migrate:rollback

# Rollback all migrations
php aura migrate:reset

# Drop all tables and re-run all migrations
php aura migrate:fresh

# Rollback all and re-run all migrations
php aura migrate:refresh

# Check which migrations have run
php aura migrate:status

Seeders

Seeders populate your database with test or default data:

php aura make:seeder UserSeeder
<?php

use AuraCore\Seeder;

class UserSeeder extends Seeder
{
    public function run()
    {
        $this->db->insert('users', [
            'name'  => 'Admin',
            'email' => 'admin@example.com',
        ]);
    }
}
# Run all seeders
php aura db:seed

# Run a specific seeder
php aura db:seed --class=UserSeeder

# Drop all tables
php aura db:wipe

Middleware

Middleware sits between the request and your controller. Create it with:

php aura make:middleware Auth

Generated file (site/middleware/auth.php):

<?php

namespace SiteMiddleware;

class Auth
{
    public function handle($request, $next)
    {
        // Check authentication
        if (!isset($_SESSION['user_id'])) {
            header('Location: /login');
            exit;
        }

        return $next($request);
    }
}

Apply middleware to routes in system/config/routes.php:

$router->get('dashboard', 'dashboard@index')->middleware('auth');

Events & Listeners

AuraPHP includes a simple event system for decoupled application logic.

Creating an event

php aura make:event UserRegistered
<?php

namespace SiteEvents;

class UserRegistered
{
    public $user;

    public function __construct($user)
    {
        $this->user = $user;
    }
}

Creating a listener

php aura make:listener SendWelcomeEmail
<?php

namespace SiteListeners;

class SendWelcomeEmail
{
    public function handle($event)
    {
        // Send email to $event->user->email
    }
}

Registering & dispatching

// Register listener for event
\AuraCore\Event::listen('UserRegistered', 'SiteListeners\SendWelcomeEmail');

// Dispatch event
$event = new \SiteEvents\UserRegistered($user);
\AuraCore\Event::dispatch('UserRegistered', $event);

Form Requests & Validation

Separate validation logic from your controllers with dedicated request classes.

Creating a request

php aura make:request StoreUserRequest
<?php

namespace SiteRequests;

use AuraCore\Validator;

class StoreUserRequest
{
    protected $rules = [];
    protected $messages = [];

    public function rules()
    {
        return $this->rules;
    }

    public function messages()
    {
        return $this->messages;
    }

    public function validate(array $data)
    {
        $validator = new Validator();
        return $validator->validate($data, $this->rules(), $this->messages());
    }

    public function authorize()
    {
        return true;
    }
}

Custom validation rules

php aura make:rule Uppercase
<?php

namespace SiteRules;

class Uppercase
{
    public function validate($attribute, $value, $params, $data)
    {
        return strtoupper($value) === $value;
    }

    public function message($attribute, $params)
    {
        return "The {$attribute} field must be uppercase.";
    }
}

Usage in a request:

protected $rules = [
    'username' => 'required|min:3|max:50',
    'email'    => 'required|email',
    'role'     => 'uppercase', // custom rule
];

Model Scopes

Global scopes allow you to automatically add constraints to all queries for a model.

php aura make:scope Active
<?php

namespace SiteScopes;

use AuraCore\Model;

class Active
{
    public function apply(Model $model, $query)
    {
        return $query->where('active', 1);
    }
}

Attach the scope in your model's boot() method:

class User extends Model
{
    protected function boot()
    {
        $this->addGlobalScope(new SiteScopes\Active());
    }
}

Database

Configuration

Edit system/config/database.php:

return [
    'default' => [
        'driver'   => 'pdo_mysql',   // mysqli, pdo_mysql, pdo_pgsql, pdo_sqlite
        'host'     => 'localhost',
        'username' => 'root',
        'password' => 'secret',
        'database' => 'my_app',
        'charset'  => 'utf8',
    ],
];

Usage

$db = $this->loadDatabase();

// Get all rows
$users = $db->get('users');

// Get with WHERE
$user = $db->getWhere('users', ['id' => 1]);

// Insert
$id = $db->insert('users', ['name' => 'Alice', 'email' => 'alice@example.com']);

// Update
$db->update('users', ['name' => 'Bob'], ['id' => 1]);

// Delete
$db->delete('users', ['id' => 1]);

// Raw query
$results = $db->query('SELECT * FROM users WHERE active = 1');

Supported drivers

Driver Value Notes
MySQLi mysqli MySQL via mysqli extension
PDO MySQL pdo_mysql MySQL via PDO
PDO PostgreSQL pdo_pgsql PostgreSQL via PDO
PDO SQLite pdo_sqlite SQLite file database

OwnStrap CSS Framework

OwnStrap is a lightweight CSS/JS framework bundled with AuraPHP. It provides 300+ utility classes and 10+ interactive components with no external dependencies.

Quick reference

<?php ownstrap_css(); ?>   <!-- In <head> -->
<?php ownstrap_js(); ?>    <!-- Before </body> -->

Themes

<body class="theme-dark">   <!-- Dark background, light text -->
<body class="theme-light">  <!-- Light background, dark text -->

Grid system

<div class="container">
    <div class="row">
        <div class="col-12 col-md-6 col-lg-4">
            <!-- Responsive column -->
        </div>
    </div>
</div>
Class Description
.container Max 1200px centered container
.container-fluid Full width container
.row Flexbox row
.col Equal-width column
.col-1 through .col-12 Fixed-width columns
.col-sm/md/lg/xl-* Responsive breakpoint columns
.col-auto Auto-width column

Colors

Role Hex Class Prefix
Success/Green #32de84 success, green
Warning/Orange #FFB72C warning, orange
Danger/Red #FF0800 danger, red
Info/Blue #00A8E8 info, blue
Purple #a855f7 purple
Pink #ec4899 pink
Cyan #06b6d4 cyan
Indigo #6366f1 indigo
Teal #14b8a6 teal

Usage: .text-{color}, .bg-{color}, .border-{color}, .btn-{color}, .badge-{color}, .alert-{color}, .btn-outline-{color}

Gradients: .bg-gradient-{color}, .text-gradient-{color}

Components

Component Classes JS Required?
Buttons .btn .btn-{color} .btn-{sm/lg} .btn-outline-{color} .btn-group .btn-group-vertical No
Cards .card .card-body .card-header .card-footer .card-dark .card-title .card-text No
Badges .badge .badge-{color} .rounded-pill No
Alerts .alert .alert-{color} No
Modals .modal .modal-content .modal-header .modal-body .modal-close Yes
Tabs .tabs .tab-button .tab-content Yes
Accordion .accordion .accordion-item .accordion-header .accordion-body Yes
Dropdowns .dropdown .dropdown-toggle .dropdown-menu .dropdown-item .dropdown-divider Yes
Toasts .toast .toast-{color} .toast-close Yes
Collapse .collapse .collapse.show Yes
Carousel .carousel .carousel-item .carousel-control-prev/next .carousel-indicators Yes
Tooltips .tooltip (via data-tooltip attribute) Yes
Progress .progress .progress-bar .progress-bar-striped .progress-bar-animated No
Spinners .spinner .spinner-grow .spinner-{color} .spinner-sm No
Pagination .pagination .page-link .page-link.disabled .page-link.active No
Breadcrumbs .breadcrumb .breadcrumb-item .breadcrumb-item.active No
Navbar .navbar .navbar-brand .navbar-nav .nav-link .navbar-toggler No
List groups .list-group .list-group-item .list-group-item.active .list-group-flush No
Input groups .input-group .input-group-text .input-control No
Shadows .shadow-sm .shadow .shadow-lg .shadow-none No

Typography

<h1> through <h6>
<p class="lead">Lead paragraph</p>
<p class="small">Small text</p>
<p class="text-xs/sm/base/lg/xl/2xl/3xl/4xl">Font sizes</p>
<p class="fw-light/normal/semibold/bold/bolder">Font weights</p>
<p class="text-start/center/end">Text alignment</p>
<p class="text-lowercase/uppercase/capitalize">Text transform</p>
<p class="text-truncate">Truncated text</p>
<p class="font-monospace">Monospace font</p>

Spacing

<div class="m-1 m-2 m-3 m-4 m-5">Margin: 0.5rem to 3rem</div>
<div class="mt-1 mb-2 ms-3 me-4">Directional margins</div>
<div class="mx-auto">Center horizontally</div>
<div class="my-3">Vertical margin shorthand</div>
<div class="p-1 p-2 p-3 p-4">Padding: 0.5rem to 2rem</div>
<div class="pt-1 pb-2 px-3 py-4">Directional padding</div>
<div class="gap-1 gap-2 gap-3 gap-4">Flex/grid gaps</div>

Display & Visibility

<div class="d-none/block/inline/inline-block/flex/grid">Display utilities</div>
<div class="d-sm/md/lg/xl-*">Responsive display</div>
<div class="d-print-none/block/flex">Print display</div>
<div class="visible/invisible">Visibility</div>
<div class="visually-hidden">Screen reader only</div>

Sizing

<div class="w-25 w-50 w-75 w-100 w-auto">Width percentages</div>
<div class="h-25 h-50 h-75 h-100 h-auto">Height percentages</div>
<div class="min-h-screen">Full viewport height</div>
<div class="h-minus-top-5">calc(100vh - 5rem) — sidebar height below navbar</div>
<div class="mw-100 vw-100 min-vw-100">Max/viewport width</div>

Glass & Theming Utilities

<div class="backdrop-blur">Blurred background filter</div>
<div class="bg-glass">Semi-transparent glass background</div>
<div class="bg-subtle">Subtle background shade</div>
<div class="bg-card">Card background color</div>

The theme-dark class on <body> or any container applies dark mode overrides to all components — cards, tables, navbars, dropdowns, alerts, badges, code blocks, and inputs.

A theme toggle is included in the base layout (system/core/content-wrapper.php) with localStorage persistence:

<button class="btn btn-sm btn-outline-info ms-2" onclick="toggleTheme()">🌙</button>

The page automatically restores the user's last-selected theme on load.

Borders & Shadows

<div class="border border-0/2/4">Borders</div>
<div class="border-start/end/top/bottom">Directional borders</div>
<div class="border-{color}">Border colors</div>
<div class="rounded rounded-circle rounded-pill">Border radius</div>
<div class="shadow-sm shadow shadow-lg shadow-none">Shadows</div>

Flexbox

<div class="d-flex flex-column flex-wrap">
<div class="align-items-center">
<div class="justify-content-start/center/end/between/around">

Position

<div class="position-relative/absolute/fixed/sticky">
<div class="fixed-top fixed-bottom sticky-top">
<div class="top-0 bottom-0 start-0 end-0 top-50 start-50">
<div class="translate-middle translate-middle-x/y">

JavaScript API

All OwnStrap JavaScript is available through the global OS object.

// Modals
OS.openModal('myModal');
OS.closeModal('myModal');

// Toasts
OS.success('Operation completed!');
OS.warning('Check your input.');
OS.error('Something went wrong.');
OS.info('Here is some information.');
OS.purple('Purple toast');
OS.pink('Pink toast');
OS.cyan('Cyan toast');
OS.showToast('Custom message', 'success', 5000);

// Tabs (via data attributes)
// <button data-tab="tab1"> triggers OS.switchTab()

// Accordion
OS.toggleAccordionItem('item1');

// Collapse
OS.toggleCollapse('myCollapse');
// <button data-toggle="collapse" data-target="myCollapse">

// Dropdown
OS.toggleDropdown('myDropdown');

// Carousel
OS.nextCarousel('myCarousel');
OS.prevCarousel('myCarousel');
OS.showCarouselItem('myCarousel', 0);

// Tooltips (via data-tooltip attribute)
// <button data-tooltip="Help text">

// Progress
OS.setProgress('progressBar', 75);
OS.animateProgress('progressBar', 0, 100, 3000);

// Form validation
OS.validateForm('myForm');
OS.clearForm('myForm');
OS.getFormData('myForm');

// HTTP requests
await OS.get('/api/users');
await OS.post('/api/users', { name: 'Alice' });
await OS.put('/api/users/1', { name: 'Bob' });
await OS.del('/api/users/1');

// Storage
OS.storage.set('key', { data: 'value' });
OS.storage.get('key');
OS.storage.remove('key');

// Cookies
OS.cookie.set('theme', 'dark', 30);
OS.cookie.get('theme');
OS.cookie.remove('theme');

// Utilities
OS.copyToClipboard('Text to copy');
OS.smoothScroll('section2');
OS.debounce(fn, 300);
OS.throttle(fn, 100);

Accessibility

AuraPHP and OwnStrap include built-in accessibility features:

  • Focus trap in modals (Tab/Shift+Tab cycle)
  • Keyboard navigation for tabs (Arrow Left/Right)
  • Keyboard navigation for accordions (Enter/Space)
  • aria-expanded dynamically set on dropdowns, collapse, accordion
  • aria-haspopup on dropdown toggles
  • :focus-visible outline on all focusable elements
  • prefers-reduced-motion disables all animations
  • visually-hidden and visually-hidden-focusable for screen readers
  • Print styles hide navbar, expand link URLs, remove card shadows

Server Configuration

Apache (.htaccess)

The included .htaccess rewrites all non-file requests to index.php:

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L]

Nginx

server {
    listen 80;
    server_name my-app.local;
    root /var/www/my-app;

    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$args;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

PHP Built-in Server

php aura serve
# or directly:
php -S 127.0.0.1:8080 -t .

Configuration Reference

Application config (system/config/config.php)

<?php
return [
    'base_url' => 'http://localhost:8080',
    // Add custom config here
];

Access in controllers: $this->config('base_url')

Database config (system/config/database.php)

<?php
return [
    'default' => [
        'driver'   => 'pdo_mysql',
        'host'     => 'localhost',
        'username' => 'root',
        'password' => '',
        'database' => 'my_app',
        'charset'  => 'utf8',
    ],
    'analytics' => [
        'driver'   => 'pdo_pgsql',
        'host'     => 'db.example.com',
        'username' => 'analytics_user',
        'password' => 'secret',
        'database' => 'analytics_db',
    ],
];

Access in controllers: $this->loadDatabase('default') or $this->loadDatabase('analytics')

Complete Component Reference

Text Colors

.text-success, .text-warning, .text-danger, .text-info, .text-purple, .text-pink, .text-cyan, .text-indigo, .text-teal, .text-dark, .text-light, .text-muted, .text-white, .text-black

Backgrounds

.bg-primary, .bg-secondary, .bg-success, .bg-warning, .bg-danger, .bg-info, .bg-purple, .bg-pink, .bg-cyan, .bg-indigo, .bg-teal, .bg-dark, .bg-light, .bg-transparent

Gradients

.bg-gradient-success, .bg-gradient-warning, .bg-gradient-danger, .bg-gradient-info, .bg-gradient-purple, .bg-gradient-pink, .bg-gradient-indigo, .bg-gradient-cyan, .bg-gradient-teal, .bg-gradient-sunset, .bg-gradient-ocean, .bg-gradient-forest, .bg-gradient-twilight, .text-gradient-success, .text-gradient-danger, .text-gradient-info, .text-gradient-purple, .text-gradient-rainbow

Buttons

.btn, .btn-primary/secondary/success/warning/danger/info/dark/light, .btn-outline-*, .btn-sm, .btn-lg, .btn-group, .btn-group-vertical

Cards

.card, .card-light, .card-dark, .card-header, .card-body, .card-footer, .card-title, .card-text

Forms

.field-group, .field-label, .input-control, .input-control-sm/lg, .select-control, .field-text, .state-valid, .state-invalid, .check-option, .check-input, .check-label, .input-group, .input-group-text

Tables

.data-table, .data-table-striped, .data-table-bordered, .data-table-hover, .data-table-success/warning/danger/info/dark/light, .responsive-table

Badges

.badge, .badge-success/warning/danger/info/dark/light, .badge-pulse, .rounded-pill

Alerts

.alert, .alert-success/warning/danger/info

List Groups

.list-group, .list-group-item, .list-group-item.active, .list-group-flush

Navigation

.navbar, .navbar-light, .navbar-brand, .nav, .nav-link, .navbar-toggler, .navbar-collapse, .pagination, .page-link, .breadcrumb, .breadcrumb-item

Environment File

AuraPHP supports .env files for environment-specific configuration:

php aura key:generate

This creates .env with an APP_KEY:

APP_KEY=0123456789abcdef0123456789abcdef

AI & Credits

AuraPHP is an AI-built project, directed and partially hand-written by a human contributor.

The tool used to build this project is OpenCode — an open-source AI coding agent that runs in your terminal. OpenCode is the only AI tool used; no other AI assistant, IDE plugin, or coding service was involved. The bulk of the code, this README, and the documentation were produced by OpenCode operating on the project lead's prompts.

Human contributions

The project lead (@kernelk14) made the following direct contributions alongside the AI-generated work:

  • Wrote the first version of OwnStrap — the original CSS/JS component library was hand-authored by the project lead before any AI assistance. The AI later modified, extended, and refined it into the current version.
  • Contributed code in the project — a number of files, helpers, design decisions, and bug fixes across the framework and the CLI came directly from the project lead, not from the AI.
  • Wrote the prompting — every line of AI output in this repository was directed by prompts authored by the project lead. The AI executed the work; the human specified what to build, gave feedback, reviewed diffs, and steered the iterations from start to finish.

In short: the AI did the heavy lifting, but the project lead designed the system, wrote the original OwnStrap, contributed code directly, and guided the AI through every step of the build.

License

AuraPHP is open source software licensed under the MIT License.