Code Monkey home page Code Monkey logo

discord.rss's Introduction

Discord.RSS

Driven by the lack of comprehensive RSS bots available, I have decided to try my hand at creating one of my own. Designed with as much customization as possible for both users and bot hosters, while also (or should be) easy to understand.

All documentation can be found at https://github.com/synzen/Discord.RSS/wiki.

Looking for a non-Discord version of this bot? See https://github.com/synzen/feedtracker

Setting Up via Cloning Repository (for most people)

See https://github.com/synzen/Discord.RSS/wiki/Setup

Setting Up with Existing Client

The fastest way to using Discord.RSS with an existing discord.js client with npm:

npm install discord.rss
const Discord = require('discord.js')
const DiscordRSS = require('discord.rss')

const client = new Discord.Client()
const drss = new DiscordRSS.Client({ database: { uri: './sources' } }) // File-based sources instead of Mongo

client.login('token')
drss.login(client) // Can be done before or after the client is 'ready'

or create a new client:

const DiscordRSS = require('discord.rss')

const drss = new DiscordRSS.Client({ database: { uri: './sources' } }) // Optional config overrides
drss.login('token')

There are multiple ways of integrating Discord.RSS programmatically - see here for more information. For full features, use a mongodb database.uri instead of a directory.

Built With

Core Functions

Customization Functions

Deploy to Heroku

You can deploy the bot in a simple way to Heroku using the button below. Click here for detailed instructions.

Deploy

If you want to deploy manually you can follow this guide.

Contributing

Read the contribution guidelines. All the latest updates are commited to the dev branch.

Locales

To add or contribute to menu translations (locales):

  1. If the locale JSON doesn't exist in src/locales, create one by running node scripts/locales/create.js
  2. Open the relevant locale file in src/locales
  3. Add your translations (use the en-US.json locale as reference)
  4. Verify your file(s) by running node scripts/locales/verify.js and make appropriate fixes
  5. Make a pull request for your changes!

discord.rss's People

Contributors

chilace avatar dependabot[bot] avatar hpacleb avatar im-mortal avatar infinitepower18 avatar macleykun avatar nevesz avatar nntin avatar shikhir-arora avatar synzen avatar ultima1252 avatar xirpy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.