diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000..d8749f7a --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,10 @@ +{ + "name": "Dune Sync", + "build": { + "context": "..", + "dockerfile": "../Dockerfile" + }, + "mounts": [ + "source=${localEnv:HOME}/.ssh,target=/root/.ssh,type=bind,consistency=cached" + ] +} diff --git a/README.md b/README.md index 8732772d..0561b9f0 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,16 @@ Components for syncing off-chain data with Dune Community Sources # Local Development 1. Clone Repo `git clone git@github.com:cowprotocol/dune-sync.git` -2. Several Makefile Commands `make XXX` +2. If using VS Code, open in devcontainer to ensure same setup as the final container. +3. Several Makefile Commands `make XXX` Key make commands are; `install, check, test` +To execute the main binary (inside the container) run + +``` +python3 -m src.main --sync-table <job> +``` + # Docker ### Build @@ -57,4 +64,4 @@ docker run -v ${PWD}/data:/app/data \ --sync-table SYNC_TABLE ``` -This will empty the buckets and repopulate with the appropriate changes. \ No newline at end of file +This will empty the buckets and repopulate with the appropriate changes.