Skip to content
Moderator toolbox for reddit extension development.
JavaScript CSS
Branch: master
Clone or download
Latest commit 2b72a74 Oct 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
extension V5.2.1 Oct 18, 2019
.editorconfig eslint fix, yml spacing cleanup Oct 16, 2019
.eslintignore re-enable modmailpro Jan 27, 2019
.eslintrc.json switch no-prototype-builtins to warn Oct 4, 2019
.gitattributes json line endings. Jun 17, 2019
.gitignore automate doc creation Oct 16, 2019
.sonarcloud.properties
.travis.yml Change code doc url, more code analysis. Oct 17, 2019
CONTRIBUTING.md Updated README and CONTRIBUTING Oct 3, 2019
LICENSE license Mar 11, 2018
PRIVACY.md add privacy policy to the repo. Jun 5, 2019
README.md Change code doc url, more code analysis. Oct 17, 2019
build.js eslint fix, yml spacing cleanup Oct 16, 2019
jsdoc.json automate doc creation Oct 16, 2019
package-lock.json V5.2.0 Spying Squirrel Oct 17, 2019
package.json

README.md

toolbox for reddit Build status DeepScan grade Chat on IRC Discord

Bundled extension of the /r/toolbox moderator tools for reddit.com

Documentation: https://www.reddit.com/r/toolbox/w/docs

Contributing

Thinking about contributing to toolbox? Awesome! Here is some information to get you started!

Development

Building the extension is relatively easy through Node.js.

$ npm install          # Install dependencies
$ npm run build        # Build extension .zip files for Chrome and Firefox
$ npm run build-watch  # Automatically rebuild on file changes
$ npm run docs         # Build documentation of internal interfaces

Once you've built a .zip for your platform, you're ready to test! Remember to reload the extension between builds.

Testing on Chrome

Note: It is not needed to build for chrome as it can be run directly from source.

  • Go to chrome://extensions.
  • Check the "Developer mode" checkbox if it's not already checked.
  • Click the "Load unpacked extension..." button.
  • Load the extension directory.

Testing on Firefox (Developer or Nightly Editions)

  • Go to about:debugging.
  • Click the "Load Temporary Add-on" button.
  • Load the /build/toolbox_v<version>_firefox.zip file.

Third-party Application Support

All shared features settings and data are stored in subreddit wikis through versioned JSON. Third party applications can use this data to hook into toolbox features like usernotes. Documentation for third-party application developers looking to integrate with toolbox can be found on the wiki.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

You can’t perform that action at this time.