/weather-widget

☀️

Primary LanguageTypeScript

Weather Widget 🌞

This README covers instructions for setting up the environment, running tests, and starting the app locally.

Prerequisites

Please ensure the following are installed on your machine:

  • Node.js (version 20.x or higher recommended)
  • Yarn (version 1.x or higher)

Setup

  1. Clone the Repository

    git clone https://github.com/your-username/your-repository.git
    cd your-repository
  2. Install Dependencies

    Use Yarn to install the necessary packages:

    yarn install
  3. Set Environment Variables

    The app requires the REACT_APP_RAPID_API_KEY environment variable to function correctly. Create a .env file in the root directory of the project and add the following:

    REACT_APP_RAPID_API_KEY=<SECRET_KEY_HERE>

Tests

To verify the app's behavior, run the tests using:

yarn test
image

Running the App Locally

To start the application locally, run:

yarn start

The app will launch on http://localhost:3000. You can access it via your web browser.

Preview of the App

The preview of the widget!

Screen.Recording.2024-06-18.at.10.12.33.PM.mov