https://github.com/xdevplatform/real-time-tweet-streamer
https://github.com/xdevplatform/real-time-tweet-streamer
twitter-api-v2
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/xdevplatform/real-time-tweet-streamer
- Owner: xdevplatform
- License: apache-2.0
- Created: 2020-07-13T22:15:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-25T03:31:10.000Z (about 5 years ago)
- Last Synced: 2025-04-05T21:36:55.152Z (9 months ago)
- Topics: twitter-api-v2
- Language: JavaScript
- Homepage:
- Size: 668 KB
- Stars: 88
- Watchers: 18
- Forks: 36
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Real-Time Tweet Streamer
> An example app to stream Tweets in real-time using the filtered stream endpoints and Tweet annotations to listen for Tweets based on your own topics of interest. See the [tutorial](https://developer.twitter.com/en/docs/tutorials/building-an-app-to-stream-tweets) for some real life examples of how this can be used and a step by step on how to build this app on your own.
### 🏠 [Guided tutorial](https://developer.twitter.com/en/docs/tutorials/building-an-app-to-stream-tweets)
### ✨ [Glitch Demo](https://glitch.com/~twitter-real-time-tweet-streamer)
## Prerequisites
- Twitter Developer account: if you don’t have one already, you can [apply for one](https://developer.twitter.com/en/apply-for-access.html).
- A Twitter developer app, which can be created in your Twitter developer account.
- A bearer token from your app in the [Twitter developer portal](https://developer.twitter.com/en/docs/developer-portal/overview)
- Set up a project to obtain access to v2 endpoints in the [Twitter developer portal](https://developer.twitter.com/en/docs/developer-portal/overview)l
- Access to the [filtered stream](http://developer.twitter.com/en/docs/twitter-api/tweets/filter-stream) endpoint. You will also need to activate it in the [Twitter developer portal](https://developer.twitter.com/en/docs/developer-portal/overview) dashboard within your Twitter Developer account.
- [Node.js](https://nodejs.org/)
- [Npm](https://docs.npmjs.com/about-npm) (This is automatically installed with Node. Make sure you have npm 5.2 or higher.)
- [Npx](https://www.npmjs.com/package/npx) (Included with npm 5.2 or higher)
## Install
```sh
npm install
```
## Environment setup
- Your bearer token can be found from your app in the [Twitter developer portal](https://developer.twitter.com/en/docs/developer-portal/overview)
```sh
export TWITTER_BEARER_TOKEN=
```
## Usage
```sh
npm start
```
## Author
👤 **Tony Vu**
- Website: https://twitter.com/tonyv00
- Twitter: [@tonyv00](https://twitter.com/tonyv00)
- Github: [@tonyv](https://github.com/tonyv)
# How to Contribute
We'd love to get patches from you!
## 📝 License
By contributing your code, you agree to license your contribution under the
terms of the APLv2: https://github.com/twitter/repo-scaffolding/blob/master/LICENSE
## Code of Conduct
Read our [Code of Conduct](CODE_OF_CONDUCT.md) for the project.