diff options
| author | Alex Browne <stephenalexbrowne@gmail.com> | 2018-09-18 02:27:38 +0800 |
|---|---|---|
| committer | Fred Carlsen <fred@sjelfull.no> | 2018-12-06 19:01:16 +0800 |
| commit | dda44500c52a4b72f6a27fb2384a3f43100a1b26 (patch) | |
| tree | 49de937e27a2e0bfbc925493c881f411366df513 /packages/pipeline/README.md | |
| parent | 7b81bd831fb4b43380ba4bc256d154ab0b5f8fca (diff) | |
| download | dexon-sol-tools-dda44500c52a4b72f6a27fb2384a3f43100a1b26.tar.gz dexon-sol-tools-dda44500c52a4b72f6a27fb2384a3f43100a1b26.tar.zst dexon-sol-tools-dda44500c52a4b72f6a27fb2384a3f43100a1b26.zip | |
Rebase pipeline branch off development
Diffstat (limited to 'packages/pipeline/README.md')
| -rw-r--r-- | packages/pipeline/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/packages/pipeline/README.md b/packages/pipeline/README.md new file mode 100644 index 000000000..594454bd0 --- /dev/null +++ b/packages/pipeline/README.md @@ -0,0 +1,54 @@ +## @0xproject/pipeline + +This repository contains scripts used for scraping data from the Ethereum blockchain into SQL tables for analysis by the 0x team. + +## Contributing + +We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +## Local Dev Setup + +Requires Node version 6.9.5 or higher. + +Add the following to your `.env` file: + +``` +REDSHIFT_USER +REDSHIFT_DB +REDSHIFT_PASSWORD +REDSHIFT_PORT +REDSHIFT_HOST +WEB3_PROVIDER_URL +``` + +Running a script example: + +``` +node ./lib/scripts/scrape_data.js --type tokens +``` + +### Install dependencies: + +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` |