Skip to content

Weather360 is your easy-to-use weather companion. Stay updated with real-time weather reports, forecasts, and radar data.

License

Notifications You must be signed in to change notification settings

christianonoh/weather360

Repository files navigation

logo
📗 Table of Contents

🌎 Weather360

Welcome to Weather360, a powerful web application that provides accurate weather information for cities all around the world. With Weather360, you can easily check the current weather conditions, forecasts, and other relevant details for any location on the globe. This readme file will guide you through the installation process and provide an overview of the application's current features as well as some exciting future additions.

🛠 Built With

Tech Stack

  • Front-end Framework: React & Redux
  • Styling: CSS
  • API Integration: Fetching data from OpenWeatherMap API
  • Testing Framework: Jest
  • Package Manager: npm (Node Package Manager)

Key Features

  • Search: Enter the name of any city in the search bar to quickly get weather information for that location.
  • Current Weather: View the current weather conditions, including temperature, humidity, wind, speed, and more.
  • Responsive design: Enjoy a seamless experience on both desktop and mobile devices.

(back to top)

🚀 Live Demo & Video presentation

In the video, we provide a walkthrough of the application, demonstrating how to search for cities, view current weather conditions, and navigate the responsive design on different devices.

(back to top)

💻 Getting Started

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

Prerequisites

Before you begin, make sure you have the following prerequisites:

  • A modern web browser such as Google Chrome or Mozilla Firefox.
  • An internet connection.
  • The latest version of Book Town project code.

Setup

Clone this repository to your desired folder:

Install

Install the project dependencies by running the command:

  • npm install

To run the project, execute the following commands:

  • npm run build
  • npm start
  • The Weather360 application will now be running at http://localhost:3000

Run tests

Weather360 includes tests to ensure code quality and functionality. Before running the tests, make sure you have installed all the required dependencies by running npm install.

Stylelint

To run Stylelint and perform static code analysis on the CSS and SCSS files, use the following command:

  • Run Stylelint: npx stylelint "**/*.{css,scss}"

    This command will check all CSS and SCSS files in the project for any potential issues or style inconsistencies based on the defined Stylelint rules.

ESLint

To run ESLint and perform static code analysis on the JavaScript and React files, use the following command:

  • Run ESLint: npx eslint "**/*.{js,jsx}"

    This command will check all JavaScript and React files in the project for any potential issues or style inconsistencies based on the defined ESLint rules.

Unit Tests with Jest

Weather360 uses Jest as the testing framework for unit tests. To execute the unit tests, use the following command:

  • Run Unit Tests: npm test

    This command will run all the unit tests and provide a summary of the test results, including any failing or passing tests.

Make sure to run the tests regularly to catch any potential issues and maintain code quality throughout the development process.

(back to top)

👥 Authors

👤 Christian Onoh

(back to top)

🔭 Future Features

  • Unit Conversion: Switch between Celsius and Fahrenheit temperature units based on your preference.
  • Forecast: Get a detailed forecast for the next 7 days, with information on temperature, precipitation, and weather conditions.
  • Hourly Forecast: Get hourly weather forecasts to better plan your day.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you enjoy using Weather360, please consider supporting us to help keep the app free and accessible for everyone. Thanks for your support!

(back to top)

🙏 Acknowledgments

Original design idea by Nelson Sakwa.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

Weather360 is your easy-to-use weather companion. Stay updated with real-time weather reports, forecasts, and radar data.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published