Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.77 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.77 KB
Raw

Twickr

Send interesting tweets from Twitter to Slack.

Twickr connects to Twitter and listens for keywords you're interested in. Whenever a keyword is mentioned in a tweet, Twickr sends you a message over Slack.

Installation

Download the relevant release for your server's OS and architecture and extract the files.

Twickr Downloads

Configuration

Before you can run Twickr, you need to setup a Twitter application and a Slack Inbound Webhook.

Twitter Setup

  1. Go to Twitter's Application Management and create a new app.
  2. Fill out the name description and website and create the app.
  3. Go to "Keys and Access Tokens" and create a new access token

Slack Setup

  1. Create a new Inbound Webhook for your Slack account here

The Configuration File

Create a config.json file in the same folder as the twickr executable. An example configuration file is included in the download.

  1. Fill in the credentials for your new Twitter app and the URL from your Slack webhook.
  2. Optionally specify which channel to send Twickr messages to
  3. Enter a coma-separated list of keywords you want Twickr to keep an eye on

Running

cd <path-to-your-twickr-install>
./twickr

Normally you'll run Twickr on a server (rather than on your laptop or desktop machine) where it can keep running continuously. An easy way to make sure it stays up after you close your SSH connection is to run it in a TMUX or Screen session.

Netlify

Twickr is a small tool developed by Netlify. Netlify builds, deploys & hosts static sites and apps.