README.adoc

ri-collection-explicit-feedback-twitter

This microservice was created as a result of the OpenReq project funded by the European Union Horizon 2020 Research and Innovation programme under grant agreement No 732463.

Technical description

What does the microservice do

The goal of this microservice is to collect data from Twitter. In particular, this service collects tweets that mention a given account. The response contains a list of tweets in JSON format.

Which technologies are used

• Docker (→ https://www.docker.com/)

• Go (→ https://github.com/golang/go)

• Anaconda (→ https://github.com/ChimeraCoder/anaconda)

How to install it

ri-collection-explicit-feedback-twitter requires a installed distribution of Go https://golang.org/doc/install

Run the following commands to start the microservice:

1. docker build -t ri-collection-explicit-feedback-twitter .

2. docker run -e "CONSUMER_KEY=<YOUR_CONSUMER_KEY>" -e "CONSUMER_SECRET=<YOUR_CONSUMER_SECRET>" -e "ACCESS_KEY=<YOUR_ACCESS_KEY>" -e "ACCESS_SECRET=<YOUR_ACCESS_SECRET>" -p 9624:9624 ri-collection-explicit-feedback-twitter

The required access tokens of the Docker environment variables can be generated on the official Twitter developer page: https://developer.twitter.com/en/docs/basics/authentication/guides/access-tokens.html

How to use it (high-level description)

The API is documented by using Swagger2:

• Rendered Documentation

Notes for developers

None.

Sources

None.

How to contribute

See OpenReq project contribution Guidlines

License

Free use of this software is granted under the terms of the EPL version 2 (EPL2.0).