Raphaël G. Git Repositories - treebundle/blob - README.md

   1 Contribute
   2 ==========
   3
   4 You may buy me a Beer, a Tea or help with Server fees with a paypal donation to
   5 the address <paypal@rapsys.eu>.
   6
   7 Don't forget to show your love for this project, feel free to report bugs to
   8 the author, issues which are security relevant should be disclosed privately
   9 first.
  10
  11 Patches are welcomed and grant credit when requested.
  12
  13 Installation
  14 ============
  15
  16 Applications that use Symfony Flex
  17 ----------------------------------
  18
  19 Add bundle custom repository to your project's `composer.json` file:
  20
  21 ```json
  22 {
  23         ...,
  24         "repositories": [
  25                 {
  26                         "type": "package",
  27                         "package": {
  28                                 "name": "rapsys/treebundle",
  29                                 "version": "dev-master",
  30                                 "source": {
  31                                         "type": "git",
  32                                         "url": "https://git.rapsys.eu/treebundle",
  33                                         "reference": "master"
  34                                 },
  35                                 "autoload": {
  36                                         "psr-4": {
  37                                                 "Rapsys\\TreeBundle\\": ""
  38                                         }
  39                                 },
  40                                 "require": {
  41                                 }
  42                         }
  43                 }
  44         ],
  45         ...
  46 }
  47 ```
  48
  49 Then open a command console, enter your project directory and execute:
  50
  51 ```console
  52 $ composer require rapsys/treebundle dev-master
  53 ```
  54
  55 Applications that don't use Symfony Flex
  56 ----------------------------------------
  57
  58 ### Step 1: Download the Bundle
  59
  60 Open a command console, enter your project directory and execute the
  61 following command to download the latest stable version of this bundle:
  62
  63 ```console
  64 $ composer require rapsys/treebundle dev-master
  65 ```
  66
  67 This command requires you to have Composer installed globally, as explained
  68 in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
  69 of the Composer documentation.
  70
  71 ### Step 2: Enable the Bundle
  72
  73 Then, enable the bundle by adding it to the list of registered bundles
  74 in the `config/bundles.php` file of your project:
  75
  76 ```php
  77 <?php
  78 // config/bundles.php
  79
  80 <?php
  81
  82 return [
  83     // ...
  84     Rapsys\TreeBundle\RapsysTreeBundle::class => ['all' => true],
  85 ];
  86 ```
  87
  88 ### Step 3: Configure the Bundle
  89
  90 Setup configuration file `config/packages/rapsys_tree.yaml` with the following
  91 content available in `Resources/config/packages/rapsys_tree.yaml`:
  92
  93 ```yaml
  94 #Services configuration
  95 services:
  96 ```
  97
  98 Setup configuration file `config/packages/myproject.yaml` with the following
  99 content available in `Resources/config/packages/rapsys_tree.yaml`:
 100
 101 ```yaml
 102 #Services configuration
 103 services:
 104 ```
 105
 106 Open a command console, enter your project directory and execute the following
 107 command to see default bundle configuration:
 108
 109 ```console
 110 $ bin/console config:dump-reference RapsysTreeBundle
 111 ```
 112
 113 Open a command console, enter your project directory and execute the following
 114 command to see current bundle configuration:
 115
 116 ```console
 117 $ bin/console debug:config RapsysTreeBundle
 118 ```