https://github.com/cskartikey/sonar

https://github.com/cskartikey/sonar

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/cskartikey/sonar
• Owner: cskartikey
• Created: 2024-08-25T06:34:07.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T16:54:02.000Z (4 months ago)
• Last Synced: 2024-08-28T19:14:45.583Z (4 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sonar

Since Hack Club's Slack is not on Enterprise Grid, admin.* API endpoints are not available, making audit logs and moderation more challenging. **Sonar** leverages the available endpoints to improve moderation capabilities.

## Running it Locally

1. Clone the repo `git clone https://github.com/hackclub/Sonar`

2. Install the required Python packages `pip install -r requirements.txt`

3. Create a `.env` file in the root directory use `sample.env` as example or the following

   ```env

   AllOWED_CHANNEL_ID=

   SLACK_USER_TOKEN=

   SLACK_BOT_TOKEN=

   SLACK_APP_TOKEN=

   ES_HOST=

   ES_PORT=

   ES_INDEX=

   ES_USER=

   ES_PASS=

   ```

4. Run it! `python main.py`