aboutsummaryrefslogtreecommitdiffhomepage
path: root/dummy-data/README.md
blob: 78b2243608b8a6af0ba62cd72403541f2e80c361 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Dummy data

This directory content makes possible to test custom services cards or create a demo without actually running the service.
The principle is simple: save a sample output of the API used in the service in a static file in this directory. The path must be identical as the service endpoint to be used seamlessly.

## Start the mock server to expose dummy data

```sh
yarn mock
```

## How to add a new services sample

- create a directory for your service, and any sub-folder existing in the service api path.
- save the api output in a file named after the service endpoint.

Example:

```sh
mkdir pihole
curl http://my-pihole.me/admin/api.php -o pihole/api.php # /admin is omited because for PiHole, the implementation expect it to be in the base url (`url` or `endpoint` property)
```