keraken/view-components

Flexible Framework-Agnostic UI for Enterprise Web Applications


README

Flexible Framework-Agnostic UI for Enterprise Web Applications

Release Scrutinizer Code Quality Build Status Code Coverage

Project status: alpha since 2016-08-12

Have questions? Ask in issue-tracker.

Table of Contents

Requirements

  • PHP 5.5+ (hhvm & php7 are supported)

Installation

Installing into Existing Project

The recommended way of installing the component is through Composer.

Run following command from your project folder:

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.

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.

If you want to use default settings and run it silently, just add --no-interaction option.

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.

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

This kind of installation has additional requirements:

  • ext-curl
  • ext-pdo_sqlite

Demo Application

This package bundled with demo-application.

Souce code of demos available here

Working Demo

Travis CI automatically deploys web-application bundled with this package to Heroku.

Here you can see working demos: http://view-components.herokuapp.com/

First run may be slow because Heroku shutting down workers when there is no traffic and starts it again on first visit

Running Demo Application Locally

To run it locally, you must install this package as stand-alone project with dev-dependencis.

Then, run web-server from the package directory with the following command:

composer serve

This command uses web-server bundled with PHP.

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

Documentation

Work in progress. Contributions are extremely welcome!

Testing

This application bundled with unit and acceptance tests created with PHPUnit.

To run tests locally, you must install this package as stand-alone project with dev-dependencies.

Command for running unit and acceptance tests:

composer test

Command for checking code style:

composer cs

Contributing

Please see Contributing Guidelines and Code of Conduct for details.

Security

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

License

© 2014—2016 Vitalii Stepanenko

Licensed under the MIT License.

Please see License File for more information.