README.md 1.33 KB
Newer Older
1
`Sefarad dashboard for trivalent crawler demo`
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
2
3
4
5
6
7
8

## Usage

This web component accepts the following parameters:

```html

9
<dashboard-gsicrawler
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
10
    client="<!-- elasticsearch client -->">
11
</dashboard-gsicrawler>
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
12
13
14

```

15
See the `dashboard-gsicrawler.html` and `demo/index.html` for more information.
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
16
17
18
19
20
21
22

## Installation

This web component is available in bower. 

```bash

23
$ bower install dashboard-gsicrawler
J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
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

```

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.