gios-asu/nectary

A simple PHP framework that is not tied to a web interface

1.0.1 2017-12-16 01:14 UTC

Requires

• php: >=7.0
• coduo/php-humanizer: >=2.0.0-beta
• josegonzalez/dotenv: ~3.2.0
• roave/security-advisories: dev-master
• xamin/handlebars.php: 0.10.3

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.4.3
• phpunit/phpunit: ^6.0
• satooshi/php-coveralls: >=0.6
• squizlabs/php_codesniffer: ^2.0
• theseer/phpdox: ^0.8
• wimg/php-compatibility: *
• wp-coding-standards/wpcs: ~0.14.0

MIT

• The Julie Ann Wrigley Global Institute of Sustainability at Arizona State University

README

A simple PHP framework that is not tied to a web interface.

Installation

Nectary is currently only available through GitHub, to install, add the following configuration to your composer.json:

{
    "repositories": [
        {
            "url": "https://github.com/gios-asu/nectary.git",
            "type": "git"
        }
    ],
    "require": {
        "gios-asu/nectary": "^1.0.0"
    }
}

Developing

If you add a class or change a namespace, remember to run composer update in order to add the class to the autoloader.

Check your code coverage with vendor/bin/phpunit --coverage-html ./coverage.

Documentation

Documentation can be found on the Github IO pages for this repo.

To generate the documentation, use phpDox. After running composer install, simply run ./vendor/bin/phpdox in the root of the project.