Skip to content

Latest commit

 

History

History
144 lines (85 loc) · 4.91 KB

README.md

File metadata and controls

144 lines (85 loc) · 4.91 KB
Raw

Logo

WeatherApp

Check the weather from any device!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Introducing WeatherApp, a comprehensive weather application that offers a wealth of information to keep you well-informed about the current and future weather conditions. Developed using React, TypeScript, and Bootstrap, WeatherApp provides an intuitive and visually appealing interface for users.

WeatherApp goes beyond basic weather data by offering a wide range of information. In addition to the current weather conditions, including temperature, humidity, wind speed and direction, visibility distance, precipitation, dew point, and atmospheric pressure, it also provides a 7-day forecast for the future. This ensures that you have all the essential information at your fingertips to plan your activities and make informed decisions.

To obtain accurate and reliable weather data, WeatherApp utilizes the OpenWeather API. By integrating with this powerful API, the application fetches up-to-date weather information for various locations. To ensure seamless functionality, users are required to have a valid API key, which can be obtained from the OpenWeather website.

The user experience is a priority in WeatherApp's development. With its user-friendly interface built on Bootstrap, the app offers a responsive design that adapts to different screen sizes and devices. Whether you're accessing it from your desktop, tablet, or mobile phone, WeatherApp guarantees an optimal viewing experience.

WeatherApp's React and TypeScript foundation ensures a robust and scalable codebase. The use of React's component-based architecture allows for modular development, making it easy to add new features and enhance existing ones. TypeScript adds an extra layer of type safety, catching errors at compile-time and improving the overall reliability and maintainability of the code.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • React
  • Bootstrap
  • TypeScript

(back to top)

Getting Started

Prerequisites

  • npm 
    npm install npm@latest -g
  • node 
    npm install -g npm

Installation

  1. Get a free API Key at https://home.openweathermap.org/users/sign_in
  2. Clone the repo 
    git clone https://github.com/jocarrd/WeatherApp.git
  3. Install NPM packages 
    npm install
  4. Enter your API in .env 
    const REACT_APP_OPENWEATHER_API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

[email protected]

Project Link: https://github.com/jocarrd/WeatherApp

(back to top)