Run Data Caterer

Quick start

• Java/Scala

  ---

  Instructions for using Java/Scala API via Docker

• YAML

  ---

  Instructions for using YAML via Docker

• UI App - Docker

  ---

  Instructions for Docker download

• UI App - Mac

  ---

  Instructions for Mac download

• UI App - Windows

  ---

  Instructions for Windows download

• UI App - Linux

  ---

  Instructions for Linux download

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
#If you want to run any other examples, check the class names under src/scala or src/java
#And then run with ./run.sh <class_name>
#i.e. ./run.sh CsvPlan

YAML

git clone git@github.com:data-catering/data-caterer-example.git
cd data-caterer-example && ./run.sh simple-json.yaml
#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
#If you want to run any other examples, check the files under docker/data/custom/plan
#And then run with ./run.sh <file_name>
#i.e. ./run.sh parquet.yaml

Docker

1. Docker

   docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.16.1
   

2. Open localhost:9898

Mac

1. Mac download
2. Drag Data Caterer to your Applications folder and double-click to run
3. If your browser doesn't open, go to http://localhost:9898 in your preferred browser

Windows

1. Windows download
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

Linux

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

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.