tirthajyoti-ghosh/weather-app

Weather App

A weather app that shows weather data by city.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This is a weather app that shows temperatures (current, feels like, min, max), cloudiness (%), and wind speed (m/s) by city name. The city name is obtained from form input. This app consumes OpenWeather API in the JSON format to show weather data.

Data points consumed:

• City name
• Country code
• Weather description
• Weather icon
• Current temperature
• Feels like temperature
• Minimum temperature
• Maximum temperature
• Cloudiness
• Wind speed

Built With

• Material Design Lite
• OpenWeatherMap
• Webpack
• ES6

Live demo

Deployed to Raw Githack - live demo.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/tirthajyoti-ghosh/weather-app.git

2. Install NPM packages

   npm install

3. Start local server

   npm run dev

4. Visit http://localhost:8080/ in your browser.

   OR

   Navigate to the /dist folder and open the index.html in your browser.

Usage

1. Enter the city name and press the Enter key.
2. Weather data is displayed here.
3. These are buttons to convert the temperature in their respective units.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tirthajyoti Ghosh - @terrific_ghosh - itirthahere@gmail.com

Project Link: https://github.com/tirthajyoti-ghosh/weather-app

Acknowledgements

• OpenWeatherMap
• README Icon made by Freepik from www.flaticon.com
• Img Shields
• Font Awesome
• Material Design Lite