2017 © Pedro Peláez
 

library framework

image

electro/framework

  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 3 Forks
  • 1 Open issues
  • 51 Versions
  • 7 % Grown

The README.md

Framework

The Electro framework's subsystems for the standard configuration profiles, (*1)

Rebuilding the package (for framework developers)

If you make changes to any susbsystem's composer.json, you'll need to run bin/build.php to update the package's main composer.json. Otherwise, changes to the subsystems' dependencies will have no effect.
After updating the main composer.json, you should commit the changes to Git., (*2)

Introduction

This package provides the standard framework subsystems and causes the installation of all the recommended packages for a standard framework configuration., (*3)

The standard configuration provides two profiles:, (*4)

  1. The WebProfile - the standard functionality for web applications.
  2. The ConsoleProfile - the standard functionality for console-based applications.
  3. The ApiProfile - functionality relevant for web-based APIs (ex: REST APIs).

See the framework's documentation to know more about profiles., (*5)

Subsystems vs Plugins

This package's subsystem modules provide only the main functionality of the framework., (*6)

Some optional parts of the framework are available elsewere as plugin packages that you can install on demand. Those will provide you with ORMs, database migrations, templating engines and more., (*7)

Plese refer to the framework's documentation for instructions on how to install plugins., (*8)

Installing the framework's standard package bundle

By requiring this package on your project's composer.json file, you will install the framework with all recommended packages for a standard configuration., (*9)

You should not install this package on an empty project, as it will be missing the underlying files and directory structure required by a fully-working application., (*10)

Use the Electro base installation as your application's starting point., (*11)

Installing a customized framework profile

In a near future, there will be more framework installation profiles available., (*12)

Alternative installation profiles will provide customized versions of the framework that may be more suitable for some scenarios. For instance, a "micro-framework" profile would install a minimum set of subsystems, with a narrower scope and tuned for maximum performance., (*13)

For now, this package is the only profile available, which consists of a set of subsystems that forn a generic web framework, suitable for most common usage scenarios., (*14)

When alternative profiles became available, you'll be able to find them on GitHub, on the electro-framework organization., (*15)

Log viewing support

To use the lnav command to view log files generated by the framework, type the following command to install lnav support for the framework's default log format:, (*16)

lnav -i private/packages/electro/framework/lnav.json

License

The Electro framework is open-source software licensed under the MIT license., (*17)

Electro framework - Copyright © Cláudio Silva and Impactwave, Lda., (*18)

The Versions

30/07 2018

dev-matisse

dev-matisse

  Sources   Download