https://github.com/tirthajyoti-ghosh/weather-app
A JS app that shows weather data by city.
https://github.com/tirthajyoti-ghosh/weather-app
javascript module-pattern openweathermap-api webpack4
Last synced: 5 months ago
JSON representation
A JS app that shows weather data by city.
- Host: GitHub
- URL: https://github.com/tirthajyoti-ghosh/weather-app
- Owner: tirthajyoti-ghosh
- License: mit
- Created: 2020-07-23T06:28:48.000Z (almost 5 years ago)
- Default Branch: development
- Last Pushed: 2023-01-06T12:33:01.000Z (over 2 years ago)
- Last Synced: 2024-04-23T23:07:03.395Z (about 1 year ago)
- Topics: javascript, module-pattern, openweathermap-api, webpack4
- Language: JavaScript
- Homepage: https://bit.ly/2XZlX75
- Size: 1.16 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![License: MIT][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
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](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#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](https://rawcdn.githack.com/tirthajyoti-ghosh/weather-app/0b69b93c02b080fa740a2ec65031f403675c142d/dist/index.html).
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/tirthajyoti-ghosh/weather-app.git
```
2. Install NPM packages
```sh
npm install
```
3. Start local server
```sh
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](https://github.com/tirthajyoti-ghosh/weather-app/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](https://twitter.com/terrific_ghosh) - [email protected]
Project Link: [https://github.com/tirthajyoti-ghosh/weather-app](https://github.com/tirthajyoti-ghosh/weather-app)
## Acknowledgements
* [OpenWeatherMap](https://openweathermap.org/api)
* README Icon made by Freepik from www.flaticon.com
* [Img Shields](https://shields.io)
* [Font Awesome](https://fontawesome.com)
* [Material Design Lite](https://getmdl.io/)
[contributors-shield]: https://img.shields.io/github/contributors/tirthajyoti-ghosh/weather-app.svg?style=flat-square
[contributors-url]: https://github.com/tirthajyoti-ghosh/weather-app/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/tirthajyoti-ghosh/weather-app.svg?style=flat-square
[forks-url]: https://github.com/tirthajyoti-ghosh/weather-app/network/members
[stars-shield]: https://img.shields.io/github/stars/tirthajyoti-ghosh/weather-app.svg?style=flat-square
[stars-url]: https://github.com/tirthajyoti-ghosh/weather-app/stargazers
[issues-shield]: https://img.shields.io/github/issues/tirthajyoti-ghosh/weather-app.svg?style=flat-square
[issues-url]: https://github.com/tirthajyoti-ghosh/weather-app/issues
[license-shield]: https://img.shields.io/badge/License-MIT-yellow.svg
[license-url]: https://github.com/tirthajyoti-ghosh/weather-app/blob/development/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/tirthajyoti-ghosh/