Giter Club home page Giter Club logo

100daysofcode-twitter-bot's Introduction

Greenkeeper badge

License (3-Clause BSD)

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

Imgur

Bot Features

Retweet & Like a Tweet

Screenshot1

When Followed, automated reply to the user

Screenshot2

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

Uses Cron job to tweet Project of the 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 existing 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 testing 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 API keys to .env file, your .env file should look something like this:
TWITTER_CONSUMER_KEY=xxxxxxxxxxxxxxxxxxxxdMhxg
TWITTER_CONSUMER_SECRET=xxxxxxxxxxxxxxxxxxxxkFNNj1H107PFv1mvWwEM6CZH0fjymV
TWITTER_ACCESS_TOKEN=xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxecKpi90bFhdsGG2N7iII
TWITTER_ACCESS_TOKEN_SECRET=xxxxxxxxxxxxxxxxxxxxZAU8wNKAPU8Qz2c0PhOo43cGO
SENTIMENT_KEY=xxxxxxxxxxxxxxxxxxxx7Ev80Pacp1h0c2kjsnMVVrG5m9MNlF
QUERY_STRING=#someTestHashTag
TWITTER_USERNAME=YourTestTwitterAccountName
  • Change any hashtags to #someTestHashTag so as not to spam the community hashtag.
  • npm/yarn test the tests will check all keys are available before you start ๐Ÿ‘
  • Make your suggested change.
  • Make sure the code style is in line with the existing code, run: npm run format to apply preferred formatting.
  • Create a pull request

License

BSD 3-Clause License

Copyright (c) 2017, freeCodeCamp. All rights reserved.

100daysofcode-twitter-bot's People

Contributors

amandeepmittal avatar benjaminspak avatar greenkeeper[bot] avatar ilyeshammadi avatar king0120 avatar quincylarson avatar shovanch avatar spences10 avatar stephanie56 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.