montasim/weather-readme-widget

Weather widget for GitHub profile readme.

GitHub Readme Weather Stats

Get dynamically generated weather stats on your GitHub readmes!

View Demo · Report Bug · Request Feature

Demo

Demo URL: https://weather-readme.vercel.app/api/weather

Workflow

This app is basically written with Vercel deployment plan in mind. Since I had issues with reading the configuration after deployment, decided to load the configuration from the repository itself. Tried to maintain standard! You can change it if you want some kind of different loading strategy. The weather data & icons are pulled from OpenWeather, each time the widget gets loaded. For time adjustments, UTC adjustments are done according to the Vercel instance. So it may behave wierdly in local. The API key for OpenWeather, is supplied by an environment variable named OPENWEATHERMAP. Calculations & adjustments are done and the widget template is rendered as a vector image in the final output for the weather api.

Deploy on your own Vercel instance

1. Configure your repository

   • Fork my repository
   • Edit the configurations
     • Location Dict
     • Timezone Dict
   • Edit GitHub info
     • GITHUB_USERNAME
     • GITHUB_REPO
     • GIT_BRANCH
   • Push updates in your fork!

2. Configure Vercel instance & deploy!

   • Sign up!
   • Connect & deploy your repository!
     • Just add your own appid for openweathermap api in OPENWEATHERMAP env variable.
   • Voila! It'll be up and running after that!
     • Access path - http://VERCEL_DOMAIN/api/weather

Contributions & License

This app is licensed under MIT License. ©Asif Mohaimen, 2020

Contributions are welcome! Please send your PR!

Made with ❤️!