🌦️ Discord Weather Forecast Bot

This project is a Discord bot that provides weather forecasts for specified locations. It utilizes the WeatherAPI for weather data and the Discord API for bot interactions.

Built With:

📖 Table of Contents

• ✨ Features
• ⚙️ Prerequisites
• 📥 Installation
• 🛠️ Configuration
• 🚀 Running the Bot
• 🔑 Getting API Keys
• 💬 Commands
• 📸 Preview

✨ Features

• Provides 3-day weather forecasts for a specified location.
• Supports both metric and imperial units.
• /forecast command for fetching weather information.
• /astro command for fetching astrological information.

⚙️ Prerequisites

• Bun – A fast all-in-one JavaScript runtime and package manager
• TypeScript – A strongly typed programming language built on JavaScript

📥 Installation

1. Clone the repository:

   git clone https://github.com/AdrianTomin/discord-bot.git
   cd discord-bot

2. Install dependencies: bun install

🛠️ Configuration

Create a .env file in the root of the project and add the required API keys as shown below:

DISCORD_TOKEN=your_discord_token_here
WEATHER_API_KEY=your_weatherapi_key_here
GUILD_ID=your_guild_id_here
CLIENT_ID=your_client_id_here

🔑 Getting API Keys

WeatherAPI Key (WEATHER_API_KEY)

1. Go to WeatherAPI and sign up for a free account.
2. Once logged in, navigate to your API key dashboard to retrieve your key.

Discord Bot Token (DISCORD_TOKEN)

1. Go to the Discord Developer Portal.
2. Create a new application or select an existing one.
3. Add a bot to your application Under the Bot section, then copy the Token under the "Token" section.

Guild ID (GUILD_ID)

1. Open Discord and navigate to your server.
2. Right-click on the server name and select Copy ID (make sure Developer Mode is enabled in Discord settings).

Client ID (CLIENT_ID)

1. In the Discord Developer Portal, go to your application.
2. Copy the Application ID from the General Information section (this is your CLIENT_ID).

🚀 Running the Bot

You can run the bot after setting up your environment variables in the .env file.

bun run start

The bot should now be online and ready to respond to commands in your Discord server.

💬 Commands

Command Options

/forecast

Provides a weather forecast for a specified location with options for metric or imperial units.

Option	Type	Description
location	String	Required. Specifies the location for the weather forecast. Accepts city name, postal code, or coordinates.
units	String	Optional. Sets the unit system for the forecast. Options are "metric" (default) or "imperial".

/astro

Provides the moonrise/set and sunrise/set astrological data for a specified location.

Option	Type	Description
location	String	Required. Specifies the location for the weather forecast. Accepts city name, postal code, or coordinates.

📸 Preview

Here are some screenshots to give you a glimpse of the Discord Weather Forecast Bot in action!

1. Weather Forecast Command

2. Astro Command

Badges

Authors

• @AdrianTomin