Skip to main content

Installation

Installing Modegator is a straightforward process utilizing the Reddit Developer Platform CLI.

Prerequisites​

  • You must be a moderator of the subreddit where you intend to install the app.
  • You must have the Devvit CLI installed on your local machine if you are installing a development version.

The easiest way to install Modegator is via the official Reddit App Directory:

  1. Navigate to the official Modegator listing: https://developers.reddit.com/apps/modegator
  2. Click the Add to Community button.
  3. Select your community from the dropdown list.
  4. Click Install app.

Installing via CLI (Developers)​

If you have access to the source code, you can upload and install the application directly to your subreddit.

  1. Open your terminal and authenticate with Reddit: 
    devvit login
  2. Navigate to the root directory of the Modegator repository.
  3. Upload the application to the Reddit Developer Platform: 
    devvit upload
  4. Install the uploaded version to your desired subreddit (e.g., r/my_subreddit): 
    devvit install my_subreddit

Accessing the Dashboard​

Once Modegator is installed, it integrates natively into the subreddit's moderation tools.

  1. Navigate to your subreddit on the official Reddit web or mobile app.
  2. Open the ... overflow menu on the subreddit header.
  3. Click the 🛡️Open MG Dashboard button.

The Singleton Dashboard Post​

To provide a full-screen, immersive experience, Modegator automatically generates a Private Mod Portal post in the subreddit.

  • Security: This post is strictly reserved for moderators. If a non-moderator attempts to access it, the backend instantly denies access, displaying a large red "Access Denied" screen.
  • Persistence: Modegator remembers the ID of this dashboard post. You can continually access the dashboard by clicking the "Open MG Dashboard" action or by saving the link directly.
  • Auto-Healing: If you accidentally delete the dashboard post permanently, Modegator will automatically detect the deletion and generate a fresh one the next time you click "Open MG Dashboard".

Accessing the Dashboard