https://github.com/johnfacey/link-flayer

Node.JS Discord RSS Bot
https://github.com/johnfacey/link-flayer

Last synced: 12 months ago
JSON representation

Node.JS Discord RSS Bot

• Host: GitHub
• URL: https://github.com/johnfacey/link-flayer
• Owner: johnfacey
• License: isc
• Created: 2021-03-18T18:12:09.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-22T15:48:25.000Z (about 3 years ago)
• Last Synced: 2024-05-01T15:55:04.316Z (about 2 years ago)
• Language: JavaScript
• Size: 369 KB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# 🔗 Link-Flayer

[![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/api/oauth2/authorize?client_id=820809725398089779&permissions=2048&scope=bot)

[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org)

[![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/link-flayer)

A modern Discord bot that brings RSS newsfeeds, instant web searches, and more to your Discord server! 📰

## ✨ Features

- 📰 RSS News Feed Integration

- 🔍 Instant Web Searches

- 🤖 OpenAI ChatGPT Integration

- 📊 Airtable Database Support

- 🎮 Interactive Commands

- 🌦️ Weather Alerts

- 📈 Stock Information

- 🎲 Trivia Games

- 🍳 Recipe Suggestions

- 💻 Code Snippet Search

## 🚀 Quick Start

### Installation

```bash

# Using npm

npm install link-flayer

# Or from source

git clone https://github.com/johnfacey/link-flayer.git

```

### Configuration

1. Get your Discord Bot Token from [Discord Developer Portal](https://discord.com/developers/applications/)

2. Create a `.env` file with the following variables:

```env

DATABASE_URL=''

TOKEN=''

KEY=''

BASE=''

TABLE=''

OPENAI_API=''

OPENAI_ORG=''

```

### Airtable Setup

Configure your `feeds.json` with nodes containing:

- `title`

- `link`

- `category`

![Airtable Configuration](./assets/airtable.png)

## 🤖 Bot Invitation

Add Link-Flayer to your server using this link:

[Invite Link](https://discord.com/api/oauth2/authorize?client_id=820809725398089779&permissions=2048&scope=bot)

## 📝 Available Commands

| Command | Description | Example |

|---------|-------------|---------|

| `!help` | Lists all available commands | `!help` |

| `!chat` | Queries OpenAI Model | `!chat what is a pizza` |

| `!search` | Searches RSS Sources | `!search google` |

| `!get` | Retrieves Search By Index | `!get 25` |

| `!add` | Add new RSS Source Feed | `!add http://www.engadget.com/rss.xml` |

| `!update` | Updates all RSS Feeds | `!update` |

| `!quote` | Random quote | `!quote` |

| `!random` | Random article | `!random` |

| `!random category` | Random article by category | `!random sports` |

| `!answer` | Instant Live Search | `!answer salesforce` |

| `!slang` | Urban Dictionary Search | `!slang slang` |

| `!stock` | Stock Information | `!stock IBM` |

| `!play` | Trivia game | `!play` |

| `!npm` | NPM package info | `!npm axios` |

| `!alert` | Weather alerts | `!alert TX` |

| `!calc` | Calculator | `!calc 2 + 2` |

| `!food` | Random recipe | `!food` |

| `!code` | Code snippet search | `!code python loop` |

| `!remind` | Sets a reminder:  | `!remind 2d1h30m Take out the trash* (d=days, h=hours, m=minutes, s=seconds)` |

## 📸 Preview

![Bot Preview](./assets/ss1.png)

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.