reddit-moderator-toolbox-redesign's Introduction

toolbox for reddit

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

Chrome

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.

Reload the extension when needed.

Firefox (developer or nightly edition)

Go to about:debugging.
Click the "Load Temporary Add-on" button.
Point to extension/manifest.json.

Reload the addon when needed.

Building

Note that it is not needed to use the build process for development purposes, all supported browsers can run the unpacked version of toolbox directly from the /extension directory

Building is relatively easy through nodejs with gulp.

Install gulp globally.

$ npm install --global gulp manifoldjs

Then navigate to the root of the toolbox folder and install the dependencies

$ npm install

To build toolbox now simply run

$ gulp

Or if you have followed these steps before and are on windows click the build.bat file.

This will create a zip file which can be used in both Chrome as well as Firefox versions that support web extensions.

Third party 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.

Examples:

Recommend Projects