GithubHelp home page GithubHelp logo

kide-notifier-discord's Introduction

kide-notifier-discord

The kide-notifier-discord is a bot designed to monitor Kide.App products (events, products or memberships) and notify Discord servers about them. The bot posts notifications about new products, product updates and reminders for upcoming sales. The bot targets text channels named kide-helper in every Discord server it's present in.

Features

New Event Alerts: Whenever a new Kide.App product is added matching specified filters (by default events in the Metropolitan area), the bot will post a notification about it.

Updated Event Alerts: If any known event has been updated, the bot will notify you about the changes.

Upcoming Event Reminders: The bot schedules reminders to alert you about events that are coming to sale soon.

Installation

pnpm install
pnpm build
pnpm start

Requirements

  • Node.js
  • A Discord Bot Token
  • Discord Developer Account

Environment Variables

Create a .env file in the root of your project and add the following environment variables:

DISCORD_TOKEN=
DISCORD_CLIENT_ID=
DISCORD_DEVELOPER_USER_ID=
DISCORD_TEST_CHANNEL_ID=

Fill in the respective values. Additional information can be found in the config/env.ts file.

Usage

Invite the Bot: Use the bot's invite link to add it to your Discord server.

Create a Channel: Make sure you have a text channel named "kide-helper" in your server where the bot can post notifications. (the channel name can be overridden with an env variable)

Receive Notifications: After setting up, you'll automatically start receiving event notifications in the "kide-helper" channel.

kide-notifier-discord's People

Contributors

pennane avatar

Watchers

 avatar

kide-notifier-discord's Issues

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.