Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 2.86 KB

README.md

File metadata and controls

82 lines (58 loc) · 2.86 KB

GithubWatcher

Scala CI FOSSA Status Coverage Status Java Version Scala Version GitHub license

Integrated GitHub Activity Notification System.


Features

1. Follower change notification

Notify follower increase / decrease.

Examples

image


2. Repository change notification

Notify Stargazer / Watcher / Fork change both increase and decrease.

Examples

image


3. Reaction change notification

Notify Reaction Emoji increment / decrement.

Examples

image


Work Flow

  1. Get latest information of user and repository from Github API
  2. Get previous information of user and repository from database (Elasticsearch)
  3. Comparing both of them to find changes
    • Increase/Decrease of Followers
    • Increase/Decrease of Stargazers
    • Increase/Decrease of Watchers
    • Increase/Decrease of Forks
    • Increase/Decrease of Reactions Emoji
  4. Send notification message on Line
  5. Save latest information on database

Build and Run

Build with sbt

git clone https://github.com/occidere/GithubWatcher.git
cd GithubWatcher
sbt clean assembly

Run jar

export gw_tasks=followerWatchTask,repositoryWatchTask,reactionWatchTask # tasks
export gw_user_id=${YOUR_GITHUB_USER_ID}
export gw_es_endpoint=${YOUR_ES_ENDPOINT} # default: localhost:9200
export gw_es_username=${YOUR_ES_USERNAME) # Optional
export gw_es_password=${YOUR_ES_PASSWORD} # Optional
export gw_line_bot_id=${YOUR_LINE_BOT_ID}
export gw_line_channel_token=${YOUR_LINE_CHANNEL_TOKEN}
export gw_github_api_token=${YOUR_GITHUB_API_TOKEN}

java -jar target/scala-2.13/GithubWatcher.jar

License

FOSSA Status