Welcome to the main repository for Mannequin, a component theming tool for the web. This repository is primarily used for development on Mannequin itself - see the "Quick Start" section below if you are here to install Mannequin.
# Pick one or more of the "flavors" below:
composer require lastcall/mannequin-html
composer require lastcall/mannequin-twig
composer require lastcall/mannequin-drupal
# Create your .mannequin.php file for
# HTML - https://mannequin.io/extensions/html/#usage
# Twig - https://mannequin.io/extensions/twig/#usage
# Drupal - https://mannequin.io/extensions/drupal/#usage
vendor/bin/mannequin startTo work on this project, you need:
- PHP >= 7.0
- NodeJS >= 6.0
In development, there are two servers that need to be started to see your changes immediately:
- From the /ui directory, run:
yarn start. This will start the front end server running on port 3000. - Next, in .mannequin.php, use the LocalDevelopmentUI as follows:
use LastCall\Mannequin\Core\MannequinConfig; use LastCall\Mannequin\Core\Ui\LocalDevelopmentUi; $config = MannequinConfig::create([ 'ui' => new LocalDevelopmentUi('http://127.0.0.1:3000') ]) ...
- Finally, run:
src/Core/bin/mannequin start *:8000. This will start the backend server, and you should be able to visit http://localhost:8000 in your browser, and see changes to both PHP and React code as you reload the page.
This repository is split using splitsh-lite running inside of the derusse/docker-gitsplit Docker container. Pushes to the master branch, as well as pushes of any tags, will be moved to the downstream repositories.