README.md

coinmarketcap-reward-notifier

Get notified when new rewards are available on CoinMarketCap

Notifies on Discord if new rewards are available on CoinMarketCap. Fetches newest rewards from their API. It notifies to a Discord channel using Discord Webhooks.

Usage

Join my Discord server

You can follow notifications in my notifier server on Discord if you don't want to set this up yourself. It is possible to forward the messages from this server to your own.

Within a Docker container

From Docker Hub Image

This will pull the image from Docker Hub and run the image with the provided configuration for web hooks as below. It's required to provide account addresses, names and the Webhook URL or both the Webhook ID and token.

# Providing a Discord Webhook URL
docker run -d -e DISCORD_WEBHOOK_URL=<URL_HERE> knutkirkhorn/coinmarketcap-reward-notifier

From source code

# Build container from source
docker build -t coinmarketcap-reward-notifier .

# Providing a Discord Webhook URL
docker run -d -e DISCORD_WEBHOOK_URL=<URL_HERE> coinmarketcap-reward-notifier

Outside of a Docker container

# Install
npm install

# Run
npm start

Environment variables

Provide these with the docker run command or store these in a .env file.

• DISCORD_WEBHOOK_URL
  • URL to the Discord Webhook containing both the ID and the token
  • Format: DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/<ID_HERE>/<TOKEN_HERE>
• DISCORD_WEBHOOK_ID
  • ID for the Discord Webhook
• DISCORD_WEBHOOK_TOKEN
  • Token for the Discord Webhook
• WAIT_TIMEOUT (optional)
  • The time interval in milliseconds between each check of CoinMarketCap rewards.
  • Default: 3600000 (60 minutes)