view-components/view-components

Flexible Framework-Agnostic UI for Enterprise Web Applications

PHP View Components

Flexible Framework-Agnostic UI for Enterprise Web Applications

, _(*1)

Project status: alpha since 2016-08-12, _(*2)

Have questions? Ask in issue-tracker., _(*3)

Table of Contents

• Requirements
• Installation
  • Installing into Existing Project
  • Installing as Stand-alone Project
• Demo Application
  • Working Demo
  • Running Demo Application Locally
• Documentation
• Testing
• Contributing
• Security
• License

Requirements

• PHP 5.5+ (hhvm & php7 are supported)

Installation

Installing into Existing Project

The recommended way of installing the component is through Composer., _(*4)

Run following command from your project folder:, _(*5)

composer require view-components/view-components

Installing as Stand-alone Project

For running tests and demo-application bundled with this package on your system you need to install it as stand-alone project., _(*6)

composer create-project view-components/view-components

This is the equivalent of doing a git clone followed by a "composer install" of the vendors. Composer will automatically run 'post-create-project-cmd' command and that will call interactive installation., _(*7)

If you want to use default settings and run it silently, just add --no-interaction option., _(*8)

If you already cloned this repository, or you want to reinstall the package, navigate to the package folder and run composer create-project command without specifying package name., _(*9)

If you are sure that you don't need to reinstall composer dependencies, you can execute only bundled installer: composer run post-create-project-cmd, _(*10)

This kind of installation has additional requirements: * ext-curl * ext-pdo_sqlite, _(*11)

Demo Application

This package bundled with demo-application., _(*12)

Souce code of demos available here, _(*13)

Working Demo

Travis CI automatically deploys web-application bundled with this package to Heroku., _(*14)

Here you can see working demos: http://view-components.herokuapp.com/, _(*15)

First run may be slow because Heroku shutting down workers when there is no traffic and starts it again on first visit, _(*16)

Running Demo Application Locally

To run it locally, you must install this package as stand-alone project with dev-dependencis., _(*17)

Then, run web-server from the package directory with the following command:, _(*18)

composer serve

This command uses web-server bundled with PHP., _(*19)

Now, open http://localhost:8000 in the browser (for Windows users it will be opened automatically after starting web-server)., _(*20)

Documentation

• Components Overview
• Cookbook

Work in progress. Contributions are extremely welcome!, _(*21)

Testing

This application bundled with unit and acceptance tests created with PHPUnit., _(*22)

To run tests locally, you must install this package as stand-alone project with dev-dependencies., _(*23)

Command for running unit and acceptance tests:, _(*24)

composer test

Command for checking code style:, _(*25)

composer cs

Contributing

Please see Contributing Guidelines and Code of Conduct for details., _(*26)

Security

If you discover any security related issues, please email mail@vitaliy.in instead of using the issue tracker., _(*27)

License

© 2014—2016 Vitalii Stepanenko, _(*28)

Licensed under the MIT License., _(*29)

Please see License File for more information., _(*30)