Weather Web App

A weather web app connected to Visual Crossing API
Explore the docs »

View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a practical project, to get involved with redux, and how it can be tested by jest js

The features that are currently supported:

• Get weather information of a specific place in a specific time

(back to top)

Built With

• React.js
• MUI
• Redux
• Styled Components

(back to top)

Getting Started

Prerequisites

To run this project in your pc, you need:

• nodejs and npm
• an api key from Visual Crossing

Installation

1. Clone the repo

   git clone https://github.com/alireza-jahandoost/weather-web-app

2. Move to the directory

   cd weather-web-app

3. Install js dependencies

   npm install

4. Create /src/api/key.js file with your api key

   echo "export const KEY = 'Type Your Api Key Here';" >> src/api/key.js

(back to top)

Usage

To run the project, you need to start it:

npm start

Then, you can access the web app from http://localhost:3000

(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 for more information.

(back to top)

Contact

Alireza Jahandoost - [email protected]

Project Link: https://github.com/alireza-jahandoost/weather-web-app

(back to top)