Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khrj/the-overseer-frontend

Frontend for @TheOverseer, the analytics bot at Hack Club
https://github.com/khrj/the-overseer-frontend

hackclub watchingyou

Last synced: about 1 month ago
JSON representation

Frontend for @TheOverseer, the analytics bot at Hack Club

Host: GitHub
URL: https://github.com/khrj/the-overseer-frontend
Owner: khrj
License: gpl-3.0
Created: 2020-12-26T07:11:37.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2021-09-02T16:33:40.000Z (over 3 years ago)
Last Synced: 2024-11-06T02:47:08.506Z (3 months ago)
Topics: hackclub, watchingyou
Language: TypeScript
Homepage:
Size: 550 KB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # The Overseer (Frontend)

This repository contains the source for @TheOverseer, the analytics bot at Hack Club.

The Overseer is split into

- [The Backend](https://github.com/khrj/the-overseer-backend) -- A script that runs on the hour and computes Analytics

- The Frontend (This) -- Listeners for the bot's slash commands and channel-join events

- [Extras](https://github.com/khrj/TheOverseerExtras) -- Extra features for The Overseer

## Running

Run

```bash

yarn start

```

to start listening for Slack events

## Commands

### Everyone

- `/analytics-apply` - Apply to add a channel to Hack Club Analytics. This should be run by every member, in every channel, provided that the channel has humans talking to each other.

    - Examples of channels that qualify:

        - [#lounge](javascript:void(0))

        - [#code](javascript:void(0))

        - [#confessions](javascript:void(0))

    

    - Examples of channels that don't qualify:

        - [#xyzusercountstoamillion](javascript:void(0))

        - [#spam](javascript:void(0))

        - [#bot-spam](javascript:void(0))

        - [#sandbox](javascript:void(0))

- `/analytics-leaderboard` - Show the Analytics leaderboard

- `/analytics-personal` - Show your own position in the leaderboard and the amount of messages you've posted

- `/analytics-user @abcuser` - Show a particular user's position in the leaderboard and the amound of messages they've posted 

### Admins-only

- `/analytics-enable` - Enable Analytics for a channel

- `/analytics-disable` - Disable Analytics for a channel