alterfw / hero
Alter's model binding
Installs: 1 319
Dependents: 1
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 1
Requires
- php: >=5.6.0
- alterfw/common: ^0.1.0
- alterfw/meta-box: ^4.5.6
Requires (Dev)
- phpunit/phpunit: 5.x
This package is auto-updated.
Last update: 2024-10-29 04:59:08 UTC
README
Hero is a library that allows you easily create Models to your WordPress theme or plugin and interact with them through a simple and beautiful API.
Instalation
composer require alterfw/hero
Require the composer autoload file into your functions.php
:
require "vendor/autoload.php";
And Hero will be ready!
Documentation
You can read more about how Ampersand works in the documentation page.
Contributing
This project doesn't have an styleguide yet but you should follow the existing code. Before create any pull requests make sure that all tests are passing.
Development Environment
To setup de development environment first download Docker and create a virtual machine:
docker-machine create --driver virtualbox default
eval "$(docker-machine env default)"
Then run:
docker-compose up
This will create a WordPress and a theme with Hero installed as dependency.
If you want to modify the theme files, take a look at the test/fixtures
directory. These files are copied during the docker-compose up
command, so if you change anything in these files you need to terminate the process and run again.