Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lin3s/patternlibrarybuilder
Library that provides an elegant and easy way to develop a pattern library for your front-end components
https://github.com/lin3s/patternlibrarybuilder
design-system html pattern-library twig
Last synced: about 6 hours ago
JSON representation
Library that provides an elegant and easy way to develop a pattern library for your front-end components
- Host: GitHub
- URL: https://github.com/lin3s/patternlibrarybuilder
- Owner: LIN3S
- License: mit
- Created: 2017-05-14T20:34:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-12T12:22:58.000Z (over 6 years ago)
- Last Synced: 2024-04-19T04:02:59.450Z (7 months ago)
- Topics: design-system, html, pattern-library, twig
- Language: PHP
- Size: 587 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PatternLibraryBuilder
> Library that provides an elegant and easy way to develop a pattern library for your front-end components
## Features
* YAML config driven pattern library builder
* Opinated and extensible default template
* Use already existing renderers to list colors, typography, iconography
* Render twig templates in responsive viewports and with autogenerated twig "include" method and HTML output
* Easily create your renderer to adapt it to your needs
* Standalone PHP library with built-in Symfony integration
## Installation
The easiest way to install this bundle is using [Composer][1]
```bash
$ composer require lin3s/pattern-library-builder
```
## Documentation
* First use
* [Installing and configuring](docs/first_use_installing_and_configuring.md)
* [Your first page](docs/first_use_your_first_page.md)
* Renderers
* [Using renderers](docs/renderers_usage.md)
* [Creating custom renderers](docs/renderers_create_custom.md)
* Theme
* [Customizing default theme](docs/theme_customize_default.md)
* Symfony integration
* [Configuration reference](docs/symfony_configuration_reference.md)
> All the documentation is stored in the `docs` folder.
## Tests
This library is tested by **[PHPSpec][2], SpecBDD framework for PHP**.
Run the following command to launch tests:
```bash
$ vendor/bin/phpspec run -fpretty
```
Also, you can easily start a simple application to test the features that the bundle provides.
```bash
$ cd tests/Application && bin/console server:start --docroot=web
$ open http://127.0.0.1:8000/design-system
```
## Contributing
This library follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][3].
Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order
to simplify we provide a Composer script that wraps all the commands related with this process.
```bash
$ composer run-script cs
```
There is also a policy for contributing to this bundle. Pull requests must be explained step by step to make the
review process easy in order to accept and merge them. New methods or code improvements must come paired with
[PHPSpec][2] tests.
## Licensing Options
[](https://github.com/LIN3S/PatternLibraryBuilder/blob/master/LICENSE)
[1]: http://getcomposer.org
[2]: http://www.phpspec.net/en/stable/
[3]: http://cs.sensiolabs.org/