Twitter Stream

Streaming twitter hashtag to browser
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Simple website project that allows convention hosts to interact with their audiences by streaming tweets with given hashtag to screen.

(back to top)

Built With

• .Net 6
• Razor
• Bootstrap
• JQuery
• Asp.net Core
• XUnit
• Make

(back to top)

Getting Started

For starting this application follow these steps

Prerequisites

First verify that you have installed .Net by running the following command

$ dotnet --version

If output is in format 6.0.xxx then you have the correct version, if command results in error or you have outdated version of .net framework then follow installation steps mentioned here.

Installation

1. Get a Twitter API keys at https://developer.twitter.com/
2. Clone the repo

   git clone https://github.com/karafra/twitter-stream.git

3. Install dependencies

   dotnet restore

4. Enter your API keys into twitter section of configuration file

    twitter:
      apiKey: YOUR_API_KEY
      apiSecret: YOUR_API_SECRET
      bearerToken: YOUR_BEARER_TOKEN
      hashtag: "#ukraine"

(back to top)

Usage

Running this application is as simple as opening web browser. Literally ... 🎉

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add Tests
  • Connect to codecov
• Add CI
• Add Websocket communication between client and server
  • Frontend javascript to receive messages
  • Backend to send tweets
• Improve UI
  • Add styles
  • Add effects when new tweet appears

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache2.0. See LICENSE for more information.

(back to top)

Contact

Karafro - @karafro - dariusKralovic@protonmail.com.com

Project Link: https://github.com/karafra/twitter-stream

(back to top)