Initial Code Commit

Author: andrewbrooke

.eslintrc.js

@@ -0,0 +1,21 @@
+
+module.exports = {
+    "env": {
+        "es6": true,
+        "node": true
+    },
+    "extends": "google",
+    "rules": {
+        "comma-dangle": "off",
+        "indent": ["error", 4],
+        "max-len": ["error", 100],
+        "no-undef": "error",
+        "no-use-before-define": "off",
+        "object-curly-spacing": ["error", "always"],
+        "one-var": "off"
+    },
+    "parserOptions": {
+        "ecmaVersion": 8,
+        "sourceType": "module",
+    }
+};

README.md

@@ -1,2 +1,28 @@
 # reddit-bot-stream-example
-An example of a Reddit bot that looks at new Reddit comments
+
+## What is this?
+
+This repo provides an example of a Reddit bot built in Node.js.
+
+Specifically, we are looking at a stream of newly posted comments on reddit, and doing something with their contents.
+
+This is achieved through [Snoowrap](https://www.npmjs.com/package/snoowrap) as a Node.js wrapper for the Reddit API, and [Snoostorm](https://www.npmjs.com/package/snoostorm) as a way to easily access the stream of Reddit comments through Snoowrap.
+
+## Install
+
+`npm i`
+
+Create `.env` at root with the following variables, specific to your Reddit app: https://www.reddit.com/prefs/apps/
+
+```
+CLIENT_ID=***
+CLIENT_SECRET=***
+REDDIT_USER=***
+REDDIT_PASS=***
+```
+
+## Usage
+
+Running the bot
+
+`npm start`

app.js

@@ -0,0 +1,30 @@
+require('dotenv').config();
+
+const Snoowrap = require('snoowrap');
+const Snoostorm = require('snoostorm');
+
+// Build Snoowrap and Snoostorm clients
+const r = new Snoowrap({
+    userAgent: 'reddit-bot-example-node',
+    clientId: process.env.CLIENT_ID,
+    clientSecret: process.env.CLIENT_SECRET,
+    username: process.env.REDDIT_USER,
+    password: process.env.REDDIT_PASS
+});
+const client = new Snoostorm(r);
+
+// Configure options for stream: subreddit & results per query
+const streamOpts = {
+    subreddit: 'all',
+    results: 25
+};
+
+// Create a Snoostorm CommentStream with the specified options
+const comments = client.CommentStream(streamOpts); // eslint-disable-line
+
+// On comment, perform whatever logic you want to do
+comments.on('comment', (comment) => {
+    if (comment.body === ':(') {
+        comment.reply(':)');
+    }
+});