- Twit :
Twitter API Client for node
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
This bot manipulates tweets and streams by connecting to the
Twitter API via the twit
npm package. Please refer to the twit
documentation to make substantial
changes.
You can help by:
- Solving existing issues
- Adding more functionalities to the bot (see issues)
- Pointing out bugs/errors
For any of the above, please create an issue so that it can be addressed. New to GitHub issues? You can familiarize yourself with them using GitHub's guide.
- Fork the Project
- You will need your own Twitter account for testing, since the bot tweets from this account. Generate your Twitter API keys by creating a new app.
- Clone your github repo using
git clone your_repo
. - Run
npm install
to install all ependencies. - Create an
.env
file and add in your API keys and Twitter handle, like so:
TWITTER_CONSUMER_KEY=xxxxxxxxxxxxxxxxxxxxdMhxg
TWITTER_CONSUMER_SECRET=xxxxxxxxxxxxxxxxxxxxkFNNj1H107PFv1mvWwEM6CZH0fjymV
TWITTER_ACCESS_TOKEN=xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxecKpi90bFhdsGG2N7iII
TWITTER_ACCESS_TOKEN_SECRET=xxxxxxxxxxxxxxxxxxxxZAU8wNKAPU8Qz2c0PhOo43cGO
QUERY_STRING=#someTestHashtag
TWITTER_USERNAME=YourTestTwitterAccountName
- Change any hashtags to
#someTestHashtag
to avoid spamming the community hashtag. - Run
node index.js
to check all keys are available before you start. 👍 - Make your suggested change.
- Create your Feature Branch
git checkout -b feature/AmazingFeature
- Commit your Changes
git commit -m 'Add some AmazingFeature'
- Push to the Branch
git push origin feature/AmazingFeature
- Open a Pull Request
people who already contributed to 100DaysOfWeb3 Bot