CONTRIBUTING.md

Contributing

We would love for you to contribute to nhl-discord-bot and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

• Code of Conduct
• Question or Problem?
• Issues and Bugs
• Feature Requests
• Setup on Local Environment

Code of Conduct

Help us keep the project open and inclusive. Please read and follow the Code of Conduct.

Got a Question or Problem?

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. If you would like to chat about the question in real-time, you can reach out via the Discord server.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to the GitHub Repository.

Missing a Feature?

You can request a new feature by submitting an issue to the GitHub Repository.

Setup Local Environment

Requirements

• Node.js v16.9+
• Git v1.7+
• Discord Bot Token
• Google Search Engine ID
• Google APIs Key
• Bitly Generic Access Token
• Timezone Database Name

Installation

Make sure, that you have git and node installed first

git --version && node -v
# Example output:
# git version 2.36.0
# v16.14.0

Clone the repository

git clone https://github.com/conrmahr/nhl-discord-bot.git

Change directories

cd nhl-discord-bot

Install all required dependencies

npm i

Copy the config-sample.json file

cp config-sample.json config.json

Edit the config.json file

{
  "prefix": "ONE-CHARACTER-SYMBOL",
  "token": "DISCORD-BOT-TOKEN",
  "timezone": "COUNTRY/CITY",
  "activity": {
    "type": "WATCHING-OR-LISTENING",
    "name": "ANY-TEXT-STRING"
  },
  "googleSearch": {
    "cx": "GOOGLE-SEARCH-ENGINE-ID",
    "key": "GOOGLE-APIS-KEY"
  },
  "bitlyAccess": {
    "token": "BITLY-GENERIC-ACCESS-TOKEN"
  }
}

Run the bot

node .
# nhl-discord-bot is logged in!

# Open this URL in a browser to add the bot to server
https://discordapp.com/oauth2/authorize?client_id={YOUR_CLIENT_ID}&scope=bot