Skip to content

Run Data Caterer

Get Token

To run a trial of Data Caterer, you will need a username and token. Get one by following the below instructions.

  1. Join the Data Catering Slack
  2. In any channel, type /token (the message will only be seen by you)
  3. Take note of your given user-id and token values (your token value will not be shown again as it is not stored anywhere)

Quick start

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

YAML

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
#check example YAML files under:
# - docker/data/custom/plan
# - docker/data/custom/task
# - docker/data/custom/validation

Docker

  1. Docker 
    docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.15.0
  2. Open localhost:9898
  3. Login with the user and token given from here

Mac

  1. In any Slack channel, type /download-mac (the message will only be seen by you) and download from the link provided
  2. Drag Data Caterer to your Applications folder adn double-click to run
  3. If your browser doesn't open, go to http://localhost:9898 in your preferred browser
  4. Login with the user and token given from here

Windows

  1. In any Slack channel, type /download-windows (the message will only be seen by you) and download from the link provided
  2. Click on 'More info' then at the bottom, click 'Run anyway'
  3. Go to '/Program Files/DataCaterer' folder and run DataCaterer application
  4. If your browser doesn't open, go to http://localhost:9898 in your preferred browser
  5. Login with the user and token given from here

Linux

  1. In any Slack channel, type /download-linux (the message will only be seen by you) and download from the link provided
  2. If your browser doesn't open, go to http://localhost:9898 in your preferred browser
  3. Login with the user and token given from here

Report

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

Sample report can also be seen here.

Gradual start

If you prefer a step-by-step approach to learning the capabilities of Data Caterer, there are a number of guides that take you through the various data sources and approaches that can be taken when using the tool.

  • 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.