From c07eeba5f33c3a13316d8e6f1a7913dd7c8245fe Mon Sep 17 00:00:00 2001 From: Michael Winsauer Date: Mon, 21 Jan 2019 00:13:18 +0100 Subject: [PATCH] Add more information to Twitter service README --- service-twitter/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/service-twitter/README.md b/service-twitter/README.md index d243d03..94482bd 100644 --- a/service-twitter/README.md +++ b/service-twitter/README.md @@ -1,5 +1,6 @@ # Twitter Service + ## API Provides a REST-API that mainly mirrors the search API from Twitter. The service uses the official Twitter API. @@ -13,8 +14,6 @@ example: `/search/tweets.json?q=example` `GET`: `/actuator/health` Returns HTTP Status 200 if service is running -## API errors -`TODO` ## external services This twitter service uses the online twitter api. @@ -24,15 +23,19 @@ Furthermore people with an existing account, like I had, can't create new apps a So I would advise you to [apply for an account](https://developer.twitter.com/en/apply-for-access) yourself, or maybe ask someone else from the group if they have a spare key. The twitter api keys can be set in the file `twitter.env`. + ## run with docker - `docker image build -t service-twitter .` - `docker container run --env-file=twitter.env -d -p YOUR_PORT:8084 service-twitter:latest` + ## run local + ### requirements -`TODO` +- JDK 11 + ### commands -`TODO` +- `./mvnw spring-boot:run` ## examples - API call example: `curl -vs http://localhost:8084/search/tweets.json?q=Google` -- 2.43.0