Skip to content

Repository files navigation

banner

Apps.SpamMonitor - Rocket.Chat App

A comprehensive anti-spam application for Rocket.Chat that automatically detects and flags spam from new users before it reaches your Rocket.Chat community.

Installation

Prerequisites

  • Rocket.Chat Server (v8 or higher)
  • Rocket.Chat Apps CLI (@rocket.chat/apps-cli)

Setup

  1. Install the CLI (if not already installed):
    npm install -g @rocket.chat/apps-cli
  2. Clone the repository:
    git clone https://github.com/RocketChat/Apps.SpamMonitor
    cd Apps.SpamMonitor
  3. Install dependencies:
    npm install
  4. Deploy the app:
    rc-apps deploy --url <rocketchat_url> --username <username> --password <password>

Contributing

Before contributing, please read CONTRIBUTING.md to understand the project scope, and the do's and don'ts for contributions.

Before opening a PR

  1. Open an issue first, using the appropriate prefix in the title so it's easy to triage:

    • [feat] — for a new feature
    • [bug] — for a bug report
    • [refactor] — for refactoring work
  2. Lint your code:

    npm run lint
  3. Format your code with Prettier:

    npx prettier --config .prettierrc '**.ts' --write

Only once the issue is created and your changes are linted and formatted should you open the pull request.

Documentation

Here are some links to examples and documentation:

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages