Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/toolbox-team/reddit-moderator-toolbox/llms.txt

Use this file to discover all available pages before exploring further.

Getting a local build of Moderator Toolbox running takes only a few minutes. The build system uses Rollup to bundle JavaScript and copies assets into separate build/chrome and build/firefox output directories, so you end up with a ready-to-load unpacked extension for each browser.

​
Prerequisites

You need Node.js installed before you begin. No other global tools are required — the build scripts and Rollup are managed through the local node_modules.

​
Install and build

1

Clone the repository

Clone the repo from GitHub and enter the project directory:
git clone https://github.com/toolbox-team/reddit-moderator-toolbox.git
cd reddit-moderator-toolbox
2

Install dependencies

Install all Node.js dependencies:
npm install
3

Build the extension

Run a one-time build or start the file watcher for iterative development:
npm run build
Build output is written to build/chrome and build/firefox.

​
Load the extension in your browser

Chromium-based browsers

  1. Navigate to chrome://extensions (or edge://extensions, etc.).
  2. Enable the Developer mode toggle.
  3. Click Load unpacked extension….
  4. Select the build/chrome directory.

Firefox

  1. Navigate to about:debugging.
  2. Click This Firefox in the sidebar.
  3. Click Load Temporary Add-on….
  4. Select build/firefox/manifest.json.
Firefox temporary add-ons are removed when the browser closes. You will need to reload the extension each time you restart Firefox.

​
Build environment variables

You generally do not need to set these for local development, but they are available when you do need them:
VariableValuesDescription
BUILD_TYPEdev (default), beta, stableControls the build variant. Beta and stable builds are intended for distribution and are typically produced by CI.
BUILD_SHAGit commit hashThe hash of the commit being built. Optional for dev builds, but required for beta and stable — the build will warn if it is missing.
Leave both variables unset for day-to-day development. The defaults produce a dev build with inline source maps, which makes debugging in the browser significantly easier.

Build docs developers (and LLMs) love

Get started for freeTalk to us