https://github.com/kyaulabs/aurora

PHP template framework for use with HTML5/AJAX.
https://github.com/kyaulabs/aurora

ajax html html5 html5-template html5-templates javascript php php-template-engine template template-engine template-framework

Last synced: 7 days ago
JSON representation

PHP template framework for use with HTML5/AJAX.

• Host: GitHub
• URL: https://github.com/kyaulabs/aurora
• Owner: kyaulabs
• License: agpl-3.0
• Created: 2022-03-26T08:57:20.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T06:08:13.000Z (4 months ago)
• Last Synced: 2024-07-24T07:48:32.945Z (4 months ago)
• Topics: ajax, html, html5, html5-template, html5-templates, javascript, php, php-template-engine, template, template-engine, template-framework
• Language: PHP
• Homepage:
• Size: 86.9 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Aurora



[https://kyaulabs.com/](https://kyaulabs.com/)

[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-2.1-4baaaa.svg?logo=open-source-initiative&logoColor=4baaaa)](CODE_OF_CONDUCT.md)   [![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-fe5196?style=flat&logo=conventionalcommits)](https://www.conventionalcommits.org/en/v1.0.0/)   [![GitHub](https://img.shields.io/github/license/kyaulabs/aurora?logo=creativecommons)](LICENSE)   [![Gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue?logo=git&logoColor=seagreen&color=seagreen)](https://github.com/zricethezav/gitleaks)  

[![Semantic Versioning](https://img.shields.io/github/v/release/kyaulabs/aurora?include_prereleases&logo=semver&sort=semver)](https://semver.org)   [![Discord](https://img.shields.io/discord/88713030895943680?logo=discord&color=blue&logoColor=white)](https://discord.gg/DSvUNYm)

* [About](#about)

  * [What's Included](#whats-included)

* [Usage](#usage)

## About

Aurora is built for rapid deployment of sites built with AJAX content loading.

It also attempts to use the most up-to-date HTML specifications / web standards

in use today.

This has been created with personal use in mind and is highly tailored to the

types of sites I create and run. That said, this could be easily adapted to

anyones needs with a bit of work.

### What's Included

* [x] Template-based HTML header

* [x] Resource preloading

* [x] Subresource Integrity (SRI) enabled

* [x] Performance Statistics

* [x] SQL Handler

## Usage

To use Aurora, one needs to either use the default HTML header template or

create your own. Once finished, move Aurora into a folder above the web root

then create an `index.php` similar to the following:

```php

# $KYAULabs: index.php,v 1.0.0 2024/07/22 22:51:26 -0700 kyau Exp $

$rus = getrusage();

require_once(__DIR__ . "/../../aurora/aurora.inc.php");

$site = new KYAULabs\Aurora("index.html", "/cdn", true, true);

$site->title = "Website Title";

$site->description = "Full website description for search engines.";

$site->dns = ["cdn.domain.com"];

$site->preload = [

    '/css/site.min.css' => 'style',

    '/javascript/jquery.min.js' => 'script',

    '/javascript/site.min.js' => 'script',

];

$site->css = [

    '../api/css/site.min.css' => '//api.domain.com/css/site.min.css',

];

$site->js = [

    '../api/javascript/jquery.min.js' => '//api.domain.com/javascript/jquery.min.js',

    '../api/javascript/site.min.js' => '//api.domain.com/javascript/site.min.js',

];

$site->htmlHeader();

// 

echo "\t\n\t\n\t\n";

// 

$site->htmlFooter();

echo $site->comment($rus, $_SERVER['SCRIPT_FILENAME'], true);

```

Looking over the source code can give you more insights on how to utilize Aurora.