RoSS - RSS to Discord Bot

RoSS (Really Simple Syndication to Discord Bot) is a Node.js application designed to fetch articles from RSS feeds and automatically post them to specified Discord channels.

Features

Fetch articles from multiple RSS feeds.
Automatically post new articles to Discord channels.
Easy to set up and configure with YAML files.
Database migrations support for easy data management.
Built with Discord.js for seamless integration with Discord API.

Getting Started

These instructions will get you a copy of RoSS up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

Bun - A fast all-in-one JavaScript runtime.

Installation

To set up RoSS, follow these steps:

Clone the repository:

git clone https://github.com/daniel-lxs/ross-bot.git
cd ross-bot

Install dependencies:

bun install

Create a RSS.yaml (If it doesn't exist already) file in the root directory with your RSS feeds.
Run the migrations to set up your database:

bun run run-migrations

Usage

To start the bot in development mode, run:

bun run dev

For production, start the bot using:

bun run start

Configuration

RoSS is configured using YAML files where the RSS feeds are stored. A .env.example file is provided. You can specify the Discord bot token, RSS feed URLs, and the channel IDs where the articles should be posted in a .env file.

Contributing

If you'd like to contribute to RoSS, please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License.

Acknowledgments

discord.js - A powerful JavaScript library for interacting with the Discord API.
rss-parser - A small library for turning RSS XML feeds into JavaScript objects.
drizzle-orm - A lightweight ORM for SQLite and other databases.
js-yaml - JavaScript parser and dumper for YAML files.