alterfw / alter
A microframework for WordPress applications
v0.2.1
2016-05-11 16:23 UTC
Requires
- alterfw/ampersand: ^0.2.13
- alterfw/hero: ^0.2.18
- alterfw/options-page: ^0.1.1
README
A small framework that provides features to develop a real WordPress Application.
Installation
Alter uses Composer to manage dependencies, so you need to install Composer to use Alter.
Enter in the WordPress themes directory and run:
composer create-project alterfw/alter <theme-name> --prefer-dist
Documentation
You can read more about how Alter 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 Alter.