Vision

How does the code work?

This is a javascript app built with Node.js, and all of the app code is in the src directory.

The app starts in bot.js, and it polls the Reddit servers in an infinite loop. The app has two major components:

personality.js create sassy responses to certain trigger words

For changes not related to networking, running tests is often enough. But if you want to see the bot hitting the Reddit servers:

Create your bot's reddit account.
Create a reddit script app through your reddit preferences. (Use http://localhost as your redirect url, we don't need it.)
Get your OAuth username (random characters below "personal use script") and secret
Fork the main github repo and download the bot's code from your own repo
Create a file ./private/environment.yaml that looks like sample-environment.yaml
ensure your node --version is >= v6.2.1
run npm install
run node ./src/bot.js
You should have the bot up and running!

Note: You can run the bot in development mode (which won't POST requests to reddit servers) by changing the dev-mode environment variable to true

You do not need to create a reddit app to run the tests, you can use the sample-environment.yaml default values.

run npm test

Note: To run a single spec, add .only

First time getting involved in Open Source Software? Welcome, and we hope you stick around! See New to OSS guide

Thanks goes to these wonderful people who have contributed (emoji key):

_{Canna Wen} 💻 💬 🤔 👀	_{Daniel Albert} 💻	_{Bob Clingan} 💻	_fbontin 💻	_{Nitin Choudhary} 💻	_{Manuel Porto} 💻	_{Anna Do} 💻
_Charles 💻 💬 🤔	_Hasan 💻	_{Marc Fogleman} 💻	_{Eliot Wong} 💻	_Doomki 💻	_{Wing Lian} 💻	_NFerraro 💻
_{Nalin Bhardwaj} 💻 💬	_{thepassenger-hub} 💻	_{Sean Grimes} 💻	_{Rafal Dittwald} 📖	_namantw 💻	_{Dan C} 💻	_cmd-kvn 💻 🐛
_{Andrew Terranova} 💻 ⚠️	_{Jacob Allen} 💻 ⚠️	_darthpool 📖

See the Contributor Introductions thread to learn more about the people who help make this project happen!

This project follows the all-contributors specification. Contributions of any kind welcome!

This source is distributed under GNU GPLv3

Failed to load latest commit information.
.github	Move documentation (#118 )	Nov 1, 2017
docs	Move documentation (#118 )	Nov 1, 2017
src	Merge branch 'personality-refactor' of https://github.com/chazzlabs/m…	Nov 9, 2017
test	Merge branch 'personality-refactor' of https://github.com/chazzlabs/m…	Nov 9, 2017
.all-contributorsrc	Move documentation (#118 )	Nov 1, 2017
.eslintignore	Add eslint with airbnb base style guide	Oct 5, 2017
.eslintrc.json	Add lint-staged and husky (#97 )	Oct 13, 2017
.gitignore	Add more detailed README and license	Aug 10, 2017
.travis.yml	Added test coverage statistics (#110 )	Oct 23, 2017
LICENSE.txt	Add more detailed README and license	Aug 10, 2017
README.md	Move documentation (#118 )	Nov 1, 2017
package-lock.json	Merge branch 'personality-refactor' of https://github.com/chazzlabs/m…	Nov 9, 2017
package.json	Merge branch 'personality-refactor' of https://github.com/chazzlabs/m…	Nov 9, 2017
sample-environment.yaml	Update README and sample environment	Oct 1, 2017
supervisord.conf	Fix supervisor config	Oct 31, 2017