Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.25 KB

readme.md

File metadata and controls

78 lines (53 loc) · 3.25 KB

Standard - JavaScript Style Guide License (3-Clause BSD)

Helping Developers who code and participate in #100DaysOfCode share and communicate through Twitter.

![](src/images/Screen Shot 2016-11-21 at 12.45.11 PM.png)

What can this bot do?

Retweet & Like a Tweet

![](src/images/Screen Shot 2016-11-21 at 12.46.34 PM.png)

When Followed, automated reply to the user

![](src/images/Screen Shot 2016-11-21 at 12.46.25 PM.png)

Congratulating user on starting/finishing #100DaysOfCode Challenge

Imgur

#100DaysOfCode tweet has negative sentiment, tweets back encouragement

Imgur

Tracks user interaction via LevelDB so users are encouraged once a day

Pre-requisites

This bot uses the twit npm package to manipulate tweets and streams and communicate with Twitter API. Please refer documentation to make substantial changes.

Contributing

You can help out by:

  • Solving exisiting issues
  • Enhancing the bot adding more functionalities (see issues)
  • Pointing out bugs/errors

For above option(s), please create an issue so it can be addressed. New to GitHub issues? They have a pretty handy guide you can use to familiarize yourself with them.

If You Can Make the Change

What you will need:

  • Your own Twitter account for testting your changes on
  • API Keys for Twitter and Sentiment
    • Get your Twitter API keys here
    • Get your Sentiment API key here
  • Fork the repository
  • Add your API keys to the .env file:

Note that the keys are not surrouonded by ''

CONSUMER_KEY=Fw***********P9
CONSUMER_SECRET=TD************Cq
ACCESS_TOKEN=31**************UC
ACCESS_TOKEN_SECRET=r0************S2
SENTIMENT_KEY=Gj************lF

Stop tracking of the .env file so you dont push your keys back to GitHub:

$ git update-index --assume-unchanged .env
  • Change any hashtags to #someTestHashTag so as not to spam the community hashtag
  • npm start to test, make sure it's not broken before you start 👍
  • Make your suggested change
  • Make sure the code style looks similar to the existing code, note that this project uses standard
  • Create a pull request

Standard - JavaScript Style Guide

License

BSD 3-Clause License

Copyright (c) 2017, Free Code Camp. All rights reserved.