Skip to content

Commit 33ebc5e

Browse files
author
Aitor Brazaola
committed
Added Installing and Configuring documentation.
1 parent ddaf07d commit 33ebc5e

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
11
# Installing and configuring
22

3-
> TODO
3+
The easiest way to install this bundle is using Composer
4+
```bash
5+
$ composer require lin3s/pattern-library-builder
6+
```
7+
Register the Bundle in your AppKernel
8+
```php
9+
$bundles = [
10+
...
11+
new Lin3sPatternLibraryBuilderBundle(),
12+
...
13+
];
14+
```
15+
Configure the basic settings in your `config.yml`:
16+
```yaml
17+
lin3s_pattern_library_builder:
18+
theme:
19+
title: "My title"
20+
description: "My description"
21+
custom_styles:
22+
color_primary: "#000"
23+
logo: ~
24+
templates_config_files_path: "%kernel.root_dir%/PatternLibrary"
25+
```
26+
Add routes to access the Design System in your routing file:
27+
```yaml
28+
_pattern_library:
29+
resource: "@Lin3sPatternLibraryBuilderBundle/Resources/config/routing.yml"
30+
```
31+
Create a folder in your AppBundle kernel root named `PatternLibrary` to store the Pattern Library configuration
32+
and create an index configuration file.
33+
```yaml
34+
status: 0
35+
description: '<p>This is the icon card component description.</p>'
36+
renderer:
37+
type: homepage
38+
options:
39+
sections: []
40+
```
41+
Create a folder in your project's root named `templates` with the different subfolders of templates you want to have.
42+
43+
Install assets
44+
```bash
45+
$ bin/console assets:install --symlink
46+
```
47+
48+
Now you can navigate to `http://localhost:8000/design-system` and see the index page.

0 commit comments

Comments
 (0)