opifer / manual-bundle
Opifer Manual Bundle
Installs: 2 339
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 8
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=5.4
- doctrine/doctrine-bundle: ~1.2
- doctrine/orm: >=2.4
- knplabs/knp-markdown-bundle: ~1.3
- symfony/symfony: >=2.5
Requires (Dev)
- behat/mink-extension: *
- behat/mink-goutte-driver: *
- behat/mink-selenium2-driver: *
- behat/symfony2-extension: 2.0.*@dev
- liip/functional-test-bundle: dev-master
- phpunit/phpunit: ~4.2.0
This package is not auto-updated.
Last update: 2020-08-31 07:28:54 UTC
README
This bundle is still in heavy development.
It is usable but please note that this bundle will be updated quite a lot.
It is originally meant to be used with opifer/cms
,
but it is possible to use it stand-alone in your own cms system for example.
Installation
First, add the bundle to composer.json
composer require opifer/manual-bundle dev-master
Register the necessary bundles in app/AppKernel.php
public function registerBundles() { $bundles = array( ... new \Opifer\ManualBundle\OpiferManualBundle(), new \Symfony\Cmf\Bundle\RoutingBundle\CmfRoutingBundle(), new \Knp\Bundle\MarkdownBundle\KnpMarkdownBundle(), ... ); // This bundle will only be loaded on the test envoirement. if (in_array($this->getEnvironment(), array('test'))) { $bundles[] = new \Liip\FunctionalTestBundle\LiipFunctionalTestBundle(); } }
NOTE
If you useopifer/cms
you do not need to do this! You do however need to do the following and please make sure you have bower installed For the below mentioned steps we assume you have setup a database already and let symfony create it.
Last of all, you need to use the command line to cd into the manual-bundle and do a bower install
First, cd into the manual-bundle:
cd vendor/opifer/manual-bundle
Then, do:
bower install
It will install all the things it needs to run!
The last thing you need to do is:
app/console opifer:refresh
This last command will install the necessary Help markdown files
which come with the bundle and all other bundles that have the above
mentioned folder structure. if you haven't setup a help structure for
your own bundle and you would like to do that, you need to re-run either
app/console opifer:refresh
or app/console opifer:manual:index
.
I suggest you use the first one as it also re-installs the asset files and clears the cache!
Using this bundle
For using this bundle, please refer to, Getting Started in the Resources/doc
folder
NOTE: This bundle is dependent on a template file. This bundle uses 2 view files located in `Resources/views/Help. Go in those files and change the template file according to where your template file is located. We have it setup as a sensible default.
Testing
This bundle makes use of Behat and Mink, Selenium (for GUI javascript) or PhamtomJS (for CLI javascript testing if no gui is available)
We will provide a detailed description on how to let the tests pass later on.