Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/healeycodes/emojistreamer

Real-time streaming of every emoji posted to Reddit.com 🔥
https://github.com/healeycodes/emojistreamer

emoji realtime reddit

Last synced: 13 days ago
JSON representation

Real-time streaming of every emoji posted to Reddit.com 🔥

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/healeycodes/EmojiStreamer.svg?branch=master)](https://travis-ci.org/healeycodes/EmojiStreamer)

## EmojiStreamer

Real-time streaming of any emojis within comments posted to Reddit! A neat one-page app.

![EmojiStreamer](https://github.com/healeycodes/EmojiStreamer/blob/master/preview.gif)


### How does it work?

Every comment posted to Reddit is scanned for emojis using PRAW (The Python Reddit API Wrapper).

The 'scanner' is a Python child process of a Node.js app. Should an emoji be found, it's piped to the Node.js app.

From there, emojis are sent to every connected WebSocket client (a.k.a. you!) 👍


### Travis CI / Testing

Test builds are ran for every commit to `master` at the moment.

Integration tests are used to ensure that the connection to Reddit is functional.

The setup steps are the same as the install stage but swap `npm start` for `npm test`.

See `.travis.yml` for more information.


### Install

Tested with `Python 3.7` and `Node v10` but earlier versions 'should' work - we don't use any bleeding edge features.

Set your Reddit API keys to enviroment values `CLIENTID` and `CLIENTSECRET`. Set your python alias to `PY` (e.g. 'python', 'python3').

`pip install -r requirements1.txt` (named differently to allow deploying to Glitch)

`npm install`

`npm start`

The page is then hosted on `localhost`, the port is `PORT` or `8080`.


### License

MIT.