/wave-weather-bot

Wave - A real-time Telegram weather bot

Primary LanguageJavaScript


Logo

Telegram Weather Bot

Bringing weather updates to your fingertips, rain or shine, with our real-time Telegram weather bot

Explore the docs »

View Demo . Report Bug . Request Feature

Telegram Bot CN Badge Star Badge Contributions Scaler

Table Of Contents📋

  • About the Project
  • Build With
  • Installation & Setup
  • Output
  • Developer

About The Project📚

Screen Shot

This Project is developed for the Scaler Discord Node.js Project Building challenge. Embark on a journey through the skies with Wave - A realtime weather forecast bot, the groundbreaking Telegram bot designed to deliver real-time weather updates straight to your fingertips. Crafted with precision and powered by Node.js, wave seamlessly integrates with Telegram, bringing the latest meteorological insights right to your preferred chat platform.

Built With🧑‍💻

The following Technologies are used to develop the awesome bot !!

  • Node.js
  • Telegram Bot Api
  • Weather Api
  • Axios
  • Telegraf

Installation & Setup🚀

▶️ Clone the Repository

git clone https://github.com/yourusername/wave-weather-bot.git

▶️ Install Dependencies

cd wave-weather-bot
npm install

▶️ Create a Telegram Bot

Start a conversation with the BotFather on Telegram.
Use the /newbot command to create a new bot and follow the instructions.
Once created, you will receive a token for your bot

▶️ Obtain Weather API Key

Sign up for a weather API service (e.g., OpenWeatherMap, Weatherstack, etc.).
Obtain the API key provided by the weather service

▶️ Replace with your Bot Token & Api Key

const bot = new Telegraf('your_telegram_bot_token');
const OPEN_WEATHER_MAP_API_KEY = 'your_weather_api_key';

▶️ start the Node.js application

node file_name

Output & Deploy⬇️

White and Beige Minimalist Fashion Photo Collage

Once the bot runs, users can interact with it within Telegram by sending location details and receiving weather reports in response.

For more details, please refer to the Documentation

Contributing🤝

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

✯ Creating A Pull Request✅

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Developer🌐

☑️ Raj Chakraborty - Developer - Raj Chakraborty