Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iwharris/shoresy-bot

A bot that chirps Redditors with quotes from our favorite Letterkenny character
https://github.com/iwharris/shoresy-bot

Last synced: 1 day ago
JSON representation

A bot that chirps Redditors with quotes from our favorite Letterkenny character

Host: GitHub
URL: https://github.com/iwharris/shoresy-bot
Owner: iwharris
License: gpl-3.0
Created: 2019-08-27T02:30:41.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-03-26T03:06:04.000Z (8 months ago)
Last Synced: 2024-03-26T04:24:35.475Z (8 months ago)
Language: TypeScript
Size: 1.06 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

> This repository contains a great deal of colourful language and is therefore **VERY NSFW**. You have been warned!

# shoresy-bot

Shoresy is a [beloved](https://youtu.be/LHf1I6rlyDk) character on [Letterkenny](), an important biographical television show that celebrates rural Canadian culture.

`shoresy-bot` is a Reddit bot that automatically [chirps](https://www.urbandictionary.com/define.php?term=chirp) Redditors who post comments with certain key words. The bot replies to such comments using a system of matchers to select a random Shoresy quote that is appropriate for the context.

![Give yer balls a tug!](images/thread.png?raw=true)

The bot is [live on Reddit](https://reddit.com/u/shoresy___bot) and has been very well-received, regularly breaking into the [top 100 bots sitewide](https://botrank.pastimes.eu/).

## Installation

```bash
git clone [email protected]:iwharris/shoresy-bot.git shoresy-bot

cd shoresy-bot

npm install
```

## Configuration

You must provide credentials to the bot.

```bash
cp .env.example .env
```

Copy and paste your client ID, client secret, Reddit username, and Reddit password into the fields.

Alternately, you may manually set the credential env variables from `.env` prior to running the bot.

## Running

Run the bot in dev mode:

```bash
npm run dev
```

or, build Typescript and run in a more production-like setting:

```bash
npm run build
npm run start:production
```

## Testing

Shoresy wouldn't write tests if he was a software developer.

## Contributions

Fork the repository and open a pull request. PRs will only be accepted if you write them in character and chirp Shoresy in the description.

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)