rwhytsell / lurker Goto Github PK

Lurker is a twitch chat scraper built with Golang. This project is only concerned with the extraction of the chat data into a RabbitMQ topic. In the future, I may release a project around the consumption of that topic and loading into a database like couchbase.

• Golang
• RabbitMQ

To get a local copy up and running follow these simple steps.

This is an example of how to list things you need to use the software and how to install them.

• Follow instructions to install Golang
• Follow instructions to install RabbitMQ

1. Clone the repo

   git clone https://github.com/Rwhytsell/Lurker/.git

2. Install Go packages

   go install

3. Build the project

   go build

Lurker uses three flags:

• addr: The address of the twitch irc server
  • Default: irc-ws.chat.twitch.tv
• chan: The channel that lurker will be listening to
  • Default: summit1g
• creds: The credentials to connect to your rabbitmq instance
  • Default: user:password@host

Example usage:

lurker --addr irc-ws.chat.twitch.tv --chan summit1g --creds user:password@host

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

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

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

Distributed under the MIT License. See LICENSE for more information.

Ryan Whytsell - @Rwhytsell67 - [email protected]

Project Link: https://github.com/Rwhytsell/Lurker/