README.md 1.32 KB
Newer Older
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
`Sefarad dashboard for the tourpedia data.

## Usage

This web component accepts the following parameters:

```html

<dashboard-tourpedia
    client="<!-- elasticsearch client -->"
</dashboard-tourpedia>

```

See the `dashboard-tourpedia.html` and `demo/index.html` for more information.

## Installation

This web component is available in bower. 

```bash

$ bower install dashboard-tourpedia

```

This command will install it inside `bower_components` folder

## Development

Requirements:

 * Docker
 * Docker-compose

The docker-compose file can be used to test the component and to develop it.
Simply run:

```
docker compose up
```

And go to http://127.0.0.1:8080/demo/index.html

The docker-compose file mounts the current directory in the docker container, so every change you make to files locally will be reflected immediately in the browser.

If you add new dependencies to the compponent (through the `bower.json` file), you need to either run `bower install` within the container or recreate the image, like so:

```
docker compose up --build

```

Or:

```
docker exec web bower install
```

Note that the component assumes all dependencies are added in `../`.
This is the structure the component will find when installed as a dependency with bower.
To mimic that structure, the `init.sh` script automatically links the bower package.