dummy-data/README.md

   1 # Dummy data
   2
   3 This directory content makes possible to test custom services cards or create a demo without actually running the service.
   4 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.
   5
   6 ## Start the mock server to expose dummy data
   7
   8 ```sh
   9 yarn mock
  10 ```
  11
  12 ## How to add a new services sample
  13
  14 - create a directory for your service, and any sub-folder existing in the service api path.
  15 - save the api output in a file named after the service endpoint.
  16
  17 Example:
  18
  19 ```sh
  20 mkdir pihole
  21 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)
  22 ```