README.md

OpenWeather Forecast

This project creates a daily (or 5-day) forecast for some of the biggest cities in the US using the OpenWeather API.

What's Under The Hood 🧰

This app is built using a jam-packed tech stack including:

• React
• Styled components
• Zustand
• React query
• Vitest
• Typescript

Getting Started ⚙️

To get a local copy up and running, you'll need a few things installed on your machine.

Prerequisites 🛠️

• Git
• Node

Installation Steps 🔧

In your terminal, run:

$ git clone https://github.com/xRiku/open-weather-forecast.git
$ cd open-weather-forecast
$ npm i

API Key 🔑

Before launching the app, you can see there's a .env.example file that contains a VITE_OPENWEATHER_API_KEY variable and expects a value, thus you need to create a file named .env with the same variable to enable the app to function. To get the value of said variable you should go to OpenWeather's website, log in or create an account, then in the header under your username click on My API keys. There you can generate a random key. Copy the key and add it to the `.env```` file like the following VITE_OPENWEATHER_API_KEY=<your key>. Please notice that it may take a few hours for the key to be activated, so running the app may not work properly right away.

Running the Application 🚀

After installation, you can start the application by running:

$ npm run dev

Navigate to http://localhost:5173/ to see the app.

Running the Tests (Optional) ✅

To run the tests, use the following command:

$ npm run test

Contributing 🤝

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

License 📜

This project is under the MIT License - see the License for more details.