[scr-be] teavee-block-manager-bundle
| Continuous Integration |
Code Quality Review |
UnitTest Coverage |
 |
 |
 |
Overview
Welcome!
The scr-be/teavee-block-manager-bundle package provides
an extensible content and asset coordinator (CMS-ish) that offers many features and configuration options while retaining a simple API., (*1)
Grouping
This package is part of the teavee
group (explanation),
comprised of other releases with a concentration in
media, HTML, content, generator,
and related functionality., (*2)
JTT
This package represents a single project within a
large collection of open-source code released
under the Scribe namespace, comprised of framework-agnostic libraries,
and a number of Symfony bundles. These projects are authored and maintained
by Rob Frawley 2nd and
collaborators,
often with the support of Scribe Inc., (*3)
Quick Start
Installation
Get the code by requiring it explicitly via the Composer
CLI, or by editing your composer.json to reflect the dependency and updating
your project requirements. For example, to explicitly require this project using
the CLI, use the following command., (*4)
$ composer require scr-be/teavee-block-manager-bundle
To enable the bundle, register it with your Symfony application kernel by
instantiating ScribeTeaveeBlockManagerBundle within the bundle array., (*5)
// app/AppKernel.php
class AppKernel extends Kernel {
public function registerBundles() {
$bundles = [
// ...
new Scribe\Teavee\BlockManagerBundle\ScribeTeaveeBlockManagerBundle(),
];
// ...
}
}
Configuration
Available configuration values can be referenced by using the Symfony console command
app/console (assuming the Symfony full-stack framework and bundle registration).
Additionally, this bundle provides a bare console executable that can be invoked by calling
the following., (*6)
bin/teavee-block-manager config:dump-reference scribe_teavee_block_manager
Reference
API Docs
This package's API-documentation is available at scr.be/teavee-block-manager-bundle/api,
(as well as linked below via the Reference badge found under the Additional Links
header). All API-reference is build against the master Git branch and updated
automatically on each Git push---api-reference for specific releases will
be provided once this package has matured., (*7)
The entire API-reference website is auto-generated using a quick,
reliable, and well-developed CLI tool called Sami.
It is rigerously and regularly tested through its use in large, complex projects,
such as the Symfony Full-Stack Framework
, as well
as its use in smaller projects such
Twig
.
Reference Sami's GitHub page to learn how to use
it with your own projects!, (*8)
Examples/Tutorials
Currently, there is no "human-written" documentation---outside of this README.
Pending package stability and available resources, a
RTD (Read the Docs) page will be published with
additional information and tutorials, including real use-cases within the Symfony
Framework., (*9)
Contributing
Discussion
For general inquiries or to discuss a broad topic or idea, you can find
robfrawley on Freenode. There is also a #scribe channel, which can
be joined using the following link
irc.choopa.net:6669/scribe., (*10)
Issues
To report issues or request a new feature use
GitHub
or GitLab
to start a discussion. Include as much information as possible to aid in
a quick resolution. Feel free to "ping" the topic if you don't get a
response within a few days., (*11)
Code
You created additional functionality during the use of this package? Send
it back upstream! Don't hesitate to submit a pull request! Beyond the
brief requirements outlined in the
contibuting guide,
your imagination
represents the only limitation., (*12)
License
This project is licensed under the
MIT License, an
FSF-/OSI-approved
and GPL-compatible, permissive free software
license. Review the
LICENSE
file distributed with this source code for additional information., (*13)
Additional Links
| Purpose |
Status |
| Stable Release |
 |
| Dev Release |
 |
| License |
 |
| Reference |
 |
Wallogit.com
