@@ -6,14 +6,6 @@ image: "https://data.catering/diagrams/logo/data_catering_logo.svg"
66
77# Run Data Caterer
88
9- ## Get Token
10-
11- To run a trial of Data Caterer, you will need a username and token. Get one by following the below instructions.
12-
13- 1 . Join the Data Catering [ Slack] ( https://join.slack.com/t/data-catering/shared_invite/zt-2664ylbpi-w3n7lWAO~PHeOG9Ujpm~~w )
14- 2 . In any channel, type ` /token ` (the message will only be seen by you)
15- 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)
16-
179## Quick start
1810
1911<div class =" grid cards " markdown >
@@ -69,49 +61,51 @@ To run a trial of Data Caterer, you will need a username and token. Get one by f
6961git clone git@github.com:data-catering/data-caterer-example.git
7062cd data-caterer-example && ./run.sh
7163# check results under docker/sample/report/index.html folder
64+ # If you want to run any other examples, check the class names under src/scala or src/java
65+ # And then run with ./run.sh <class_name>
66+ # i.e. ./run.sh CsvPlan
7267```
7368
7469### YAML
7570
7671``` shell
7772git clone git@github.com:data-catering/data-caterer-example.git
78- cd data-caterer-example && ./run.sh
73+ cd data-caterer-example && ./run.sh simple-json.yaml
7974# check results under docker/sample/report/index.html folder
8075# check example YAML files under:
8176# - docker/data/custom/plan
8277# - docker/data/custom/task
8378# - docker/data/custom/validation
79+ # If you want to run any other examples, check the files under docker/data/custom/plan
80+ # And then run with ./run.sh <file_name>
81+ # i.e. ./run.sh parquet.yaml
8482```
8583
8684### Docker
8785
88861 . Docker
8987 ``` shell
90- docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.15.2
88+ docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.16.1
9189 ```
92902 . [ Open localhost:9898] ( http://localhost:9898 )
93- 3 . Login with the user and token given from [ here] ( #get-token )
9491
9592### Mac
9693
97- 1 . In any Slack channel, type ` / download- mac` (the message will only be seen by you) and download from the link provided
98- 2 . Drag Data Caterer to your Applications folder adn double-click to run
94+ 1 . [ Mac download] ( https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer- mac.zip )
95+ 2 . Drag Data Caterer to your Applications folder and double-click to run
99963 . If your browser doesn't open, go to [ http://localhost:9898 ] ( http://localhost:9898 ) in your preferred browser
100- 4 . Login with the user and token given from [ here] ( #get-token )
10197
10298### Windows
10399
104- 1 . In any Slack channel, type ` / download- windows` (the message will only be seen by you) and download from the link provided
100+ 1 . [ Windows download] ( https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer- windows.zip )
1051012 . Click on 'More info' then at the bottom, click 'Run anyway'
1061023 . Go to '/Program Files/DataCaterer' folder and run DataCaterer application
1071034 . If your browser doesn't open, go to [ http://localhost:9898 ] ( http://localhost:9898 ) in your preferred browser
108- 5 . Login with the user and token given from [ here] ( #get-token )
109104
110105### Linux
111106
112- 1 . In any Slack channel, type ` / download- linux` (the message will only be seen by you) and download from the link provided
107+ 1 . [ Linux download] ( https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer- linux.zip )
1131082 . If your browser doesn't open, go to [ http://localhost:9898 ] ( http://localhost:9898 ) in your preferred browser
114- 3 . Login with the user and token given from [ here] ( #get-token )
115109
116110#### Report
117111
0 commit comments