Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

The simple goal for this microservice is to offer a stateless generic capability, that can create and update reports (containing total/delta metrics), for supported reportTypes such as Twitter user/tweets and YouTube video views/likes.

License

Notifications You must be signed in to change notification settings

IBM/smarteradvocacy-build-report

Repository files navigation

Smarter Advocacy

This cloud-native express/node.js microservice, is part of a set which comprise a 'Smarter Advocacy' capability. More details about this will follow soon.

The microservice in this repo

The simple goal for this microservice is to offer a stateless generic capability, that can create and update reports (containing total/delta metrics), for supported reportTypes such as Twitter user/tweets and YouTube video views/likes.

Quick demo
hitting enpoint --> then walk through JSON output:

example endpoint hit

For you to build and deploy:

  • see separate BLOG, for how to develop changes to this cloud-native express/node.js microservice in 4 simple steps.
  • see separate BLOG, for how to deploy the latest microservice into production (an OpenShift Kubernetes cluster).

Only within IBM, this microservice is already deployed:

Overview of workflow:
overview picture

Supported reports to build are:

  1. Twitter (for any given user name), reporting totals/deltas for followers, friends, tweets, retweets and likes
  2. YouTube channel videos, reporting totals/deltas for videos, likes and dislikes

Notes:

  1. currently, the microservice is hardcoded to push the resultant JSON document to a hardcorded COUCHDB instance (but we should probably split the microservice into two parts, the first to produce the JSON document with an option where to the send it and the second to handle store in a COUCHDB. Other places to send/store the data could also be supported in future).
  2. currently the backup strategy for report JSON documents, is to keep a latest copy of the report in this Github repo. When the 'build-report' endpoint is hit in production mode, it attempts to get the latest report from Couch DB first, but if that's unavailable it looks in this repo/public directory.

...

Codewind logo

This microservice was created and iteratively developed using Codewind.
Codewind is an open source plugin for Eclispe and VS Code IDEs, that simplifies and enhances development in containers by extending industry standard IDEs with features to write, debug, and deploy cloud-native applications.

About

The simple goal for this microservice is to offer a stateless generic capability, that can create and update reports (containing total/delta metrics), for supported reportTypes such as Twitter user/tweets and YouTube video views/likes.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages