gtrchive

README

gore-twin

The GOlang REthinkdb TWitter INgester is a simple Go program to ingest Tweets and store them in RethinkDB.

Usage

The easist way to get up and running quickly is to use the official Docker image. Be sure to include your Twitter API credentials, as well as the keywords to track. See the official Twitter documentation for the keyword format.

docker run -it --rm \
    -e TWITTER_ACCESS_TOKEN=<SECRET> \
    -e TWITTER_ACCESS_SECRET=<SECRET> \
    -e TWITTER_CONSUMER_KEY=<SECRET> \
    -e TWITTER_CONSUMER_SECRET=<SECRET> \
    -e TWITTER_TRACK='foo bar,baz' \
    jmckind/gore-twin:latest

Development

Check out the source code locally and navigate to the directory.

git checout <REPO>/gore-twin.git
cd gore-twin

Next, ensure that the dependencies are present.

dep ensure

Set environment variables with Twitter credentials.

export TWITTER_ACCESS_TOKEN=<SECRET>
export TWITTER_ACCESS_SECRET=<SECRET>
export TWITTER_CONSUMER_KEY=<SECRET>
export TWITTER_CONSUMER_SECRET=<SECRET>

Set environment variable with keywords to track.

export TWITTER_TRACK='foo bar,baz'

Run the application.

go run goretwin.go

Release

Build the Docker image.

docker build <REPO>/gore-twin:latest .

Run the Docker image locally.

docker run -it --rm -e <ENV VARS>... <REPO>/gore-twin:latest

License

gore-twin is released under the Apache 2.0 license. See the LICENSE file for details.