⚡️ Weather Bot ⚡️

A NodeJS application that pushes weather notification over Telegram Bot

Usage • Configuration • Deployment • Technology Used • Contributing • Contributors • Credits

The application is powered by Github Actions to automatically push weather notification to a personal telegram bot at specific intervals. It is built on Javascript making use of NodeJS libraries.

To view this LIVE

📖 Usage

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need the below installed on your computer

• Git [email protected] or higher
• NodeJS (which comes with npm) node@v12 or higher, [email protected] or higher
• Telegram Desktop or Telegram App

Cloning the repository

$ git clone https://github.com/richierich25/weather-bot.git
$ cd weather-bot
$ npm i 

💨 Configuration

1. Create a file called .env in the root directory of your project. OR Note: Instead of creating a .env file, create a replica of the env.example file provided

   $ cp env.example .env

2. Inside the .env file, add key WEATHER_API_TOKEN obtained from OpenWeather App. One must create an account and copy the API Key from My API Key Section.

     WEATHER_API_TOKEN = "YOUR OPEN WEATHER API TOKEN HERE"

3. Inside the .env file, add key TELEGRAM_TOKEN and TELEGRAM_CHAT_ID obtained from Telegram Bots App. Follow the below steps:

   • Click BotFather and open in either Telegram Desktop or Mobile App(search for @BotFather)
   • After opening it, press start and type /newbot
   • Provide a name and a username for the bot. ensure it ends with bot at its end, for instance Richierich25_bot
   • It will provide a link to the newly created bot and provide the HTTP API Key or TELEGRAM_TOKEN. Open the link provided. important as the bot has to be started for it to receive messages later
   • Press start or to start chatting with the newly created bot
   • To obtain the TELEGRAM_CHAT_ID, search for the @get_id_bot account and pressstart
   • it will provide you your chat id

     TELEGRAM_TOKEN = "YOUR TELEGRAM TOKEN HERE"
     TELEGRAM_CHAT_ID = "YOUR TELEGRAM CHAT ID HERE"

4. Inside the index.js, set the id corresponding to your city obtained from here.

   • Enter your desired city name and press search, for instance, Delhi
   • Open the first link that pops below
   • Now from the URL, obtain the id of the format https://openweathermap.org/city/1273294 where 1273294 will be the ID corresponding to the city

     weatherURL.searchParams.set('id', '1273294');  // use the desired id here

🖥️ Deployment

When you are done with the setup, and have tested locally, we recommend you to deploy it using Github Actions. We highly recommend to read through the Using Github Actions docs.

1. Inside the .github/workflows/run-weather-bot.yml file, set the desired time interval in CRON FORMAT after which you wish the Application to execute and push further notifications

     schedule:
       - cron: '0 */3 * * *' #after every 3 hours

2. Adding API Tokens and Secrets into the repository

   • Open your repository with the application code
   • Click on Settings from the Github Menu options
   • Press Secrets from the left section
   • Press New Secret and add your tokens one by one by giving it a suitable Name and Value
   • Add WEATHER_API_TOKEN, TELEGRAM_TOKEN and TELEGRAM_CHAT_ID

🛠️ Technology Used

• NodeJS
• Javascript

🤝 Contributing

If you wish to contribute and make it much better for other developers, please have a look at Issues.

• Add UI for selecting custom City
• Customize the message notification

If you can help us with these. Please don't hesitate to open a pull request.

We encourage you to contribute. Please check out the Contributing guide for guidelines on how to proceed.

Contributors

Richard Abraham

👏🏻 Credits

• Original Idea from Kristian Freeman