Skip to content

Commit

Permalink
docs: add git clone command
Browse files Browse the repository at this point in the history
- add link to quickstart in readme
  • Loading branch information
Meghajit committed Sep 26, 2022
1 parent 82975ee commit 6b4b86c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,9 @@ Explore the following resources to get started with Dagger:
* [Usecase](https://odpf.github.io/dagger/docs/usecase/overview) describes examples use cases which can be solved via Dagger.

## Running locally
Make sure you have Java8 and local kafka-2.4+ setup pre-installed on your local machine.
```sh
# Clone the repo
$ git clone https://github.com/odpf/dagger.git

# Build the jar
$ ./gradlew clean build

# Configure env variables
$ cat dagger-core/env/local.properties
Please follow this [Dagger Quickstart Guide](https://odpf.github.io/dagger/docs/guides/quickstart) for setting up a local running Dagger consuming from Kafka.

# Run a Dagger
$ ./gradlew dagger-core:runFlink
```
**Note:** Sample configuration for running a basic dagger can be found [here](https://odpf.github.io/dagger/docs/guides/create_dagger#common-configurations). For detailed configurations, refer [here](https://odpf.github.io/dagger/docs/reference/configuration).

Find more detailed steps on local setup [here](https://odpf.github.io/dagger/docs/guides/create_dagger).
Expand Down
6 changes: 5 additions & 1 deletion docs/docs/guides/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@

## Quickstart

1. Clone dagger repository into you local. Git checkout into the main branch.
1. Clone Dagger repository into your local

```shell
git clone https://github.com/odpf/dagger.git
```
2. Next, we will generate our proto descriptor set. Ensure you are at the top level directory(`dagger`) and then fire this command

```
Expand Down

0 comments on commit 6b4b86c

Please sign in to comment.