Skip to content

Run Data Caterer

Quick start

  • Mac


    Instructions for Mac download

  • Windows


    Instructions for Windows download

  • Docker


    Instructions for Docker download

  • Linux


    Instructions for Linux download

  • Java/Scala


    Instructions for using Java/Scala API via Docker

Mac

  1. Mac download
  2. Extract zip file
  3. Double-click 'DataCaterer-1.0.0.dmg'
  4. Drag Data Caterer into 'Applications' folder
  5. Go to 'Applications' folder, right click Data Caterer, click 'Open' and then 'Open Anyway'
  6. If your browser doesn't open, go to http://localhost:9898 in your preferred browser

Windows

  1. Windows download
  2. After downloaded, go to 'Downloads' folder and 'Extract All' from data-caterer-windows
  3. Double-click 'DataCaterer-1.0.0' to install Data Caterer
  4. Click on 'More info' then at the bottom, click 'Run anyway'
  5. Go to '/Program Files/DataCaterer' folder and run DataCaterer application
  6. If your browser doesn't open, go to http://localhost:9898 in your preferred browser

Docker

  1. Docker
    docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer-basic:0.11.9
    
  2. Open localhost:9898

Linux

  1. Linux download
  2. If your browser doesn't open, go to http://localhost:9898 in your preferred browser

Java/Scala API

git clone git@github.com:data-catering/data-caterer-example.git
cd data-caterer-example && ./run.sh
#check results under docker/sample/report/index.html folder

Report

Check the report generated under docker/data/custom/report/index.html.

Sample report can also be seen here.

Slow start

Guided tour

Check out the starter guide here that will take your through step by step. You can also check the other guides here to see the other possibilities of what Data Caterer can achieve for you.