albertchau / dvt

ZipLock

Description: Pairs Data.

Project Setup

1. Java 8
2. Local Instance of MySql 5.6+

Testing

Unit Tests

1. mvn test

Integration Tests

1. Have Databases set up and all integeration points defined in the config file
2. mvn it:test

Deploying

• Can deploy via Docker, RPM, or JAR file
• Can be used as CLI or API
• Monitoring services and logging.

How to deploy

JAR

1. mvn clean package install
2. cd ziplock-xl/target
3. artifact jar will have prefix of ziplock-xl
4. to run java -jar ziplock-xl-x.jar {config_file.json}

API

1. mvn clean package install
2. cd ziplock-api/target
3. artifact jar will have prefix of ziplock-api
4. to run java -jar ziplock-api-x.jar server {config_file.yml}

Troubleshooting & Useful Tools

Examples of common tasks for CLI

e.g.

• How to ensure my data doesn't suck.
• Does the Janus workflow work, flow?
• Streaming through cliques of data for clickstream parity.

Examples of common tasks for API

API End Points

• GET /datasets
• POST /datasets
• DELETE /datasets/{id}
• GET /datasets/{id}
• PUT /datasets/{id}
• GET /datasources
• POST /datasources
• DELETE /datasources/{id}
• GET /datasources/{id}
• PUT /datasources/{id}
• POST /fields
• GET /fields/{id}
• GET /relations
• POST /relations
• GET /relations/{id}
• GET /reporters
• POST /reporters
• GET /runs
• POST /runs
• GET /runs/{id}

Contributing changes

• Internal git flow
• Pull request guidelines
• Jira - DS:TA
• "Please open github issues"

License