diff --git a/README.md b/README.md index c7c8c5c..a2b289c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +Here's a README file for your weather forecast application: + +```markdown # Weather Forecast Application ## Objective @@ -17,7 +20,7 @@ This project is a weather forecast application built using React.js that fetches - **Responsive Design**: The application is styled to be visually appealing and responsive, adapting seamlessly to various screen sizes and orientations. -- **Additional Features** : +- **Additional Features**: - Caching for the last searched city to enable offline viewing. - Pull-to-refresh functionality for updating weather data. - Performance optimizations like lazy loading components and optimizing API calls. @@ -27,28 +30,34 @@ To set up the Weather Forecast Application locally, follow these steps: 1. **Clone the Repository**: ```bash - git clone https://github.com/adaharshsingh/Propacity.git -2. **Navigate to the Project Directory:**: - ```bash - cd Propacity -3. **Install Dependencies:**: - ```bash - npm i -4. **Start the Development Server:**: + git clone https://github.com/adaharshsingh/weather-forecast-app.git + cd weather-forecast-app + ``` + +2. **Install Dependencies**: ```bash - npm run dev -5. **Create a .env File:**: + npm install + ``` + +3. **Create a .env File**: + Create a file named `.env` in the root directory and add your API key: + ```plaintext + REACT_APP_API_KEY=your_api_key_here + ``` + You can obtain the API key from the [OpenWeatherMap API](https://openweathermap.org/api). + +4. **Start the Development Server**: ```bash - VITE_API_KEY=your_api_key_here + npm start + ``` + +5. **Open Your Browser**: + Go to [http://localhost:3000](http://localhost:3000) to view the application. - #You can obtain the API key from the [Visual Crossing Weather API](https://rapidapi.com/visual-crossing-corporation-visual-crossing-corporation-default/api/visual-crossing-weather) -6. **Open Your Browser:**: - Go to http://localhost:5173 to view the application. - ## Technologies Used - **React.js** -- **CSS** -- **OpenWeatherMap API** (or your chosen weather API) +- **Axios** +- **OpenWeatherMap API** ## Contributing Contributions are welcome! If you'd like to contribute, please submit a pull request or open an issue. @@ -58,3 +67,6 @@ This project is licensed under the MIT License. ## Acknowledgements Thanks to OpenWeatherMap for providing the weather data API. +``` + +Feel free to customize any sections or add additional information that might be relevant for users or contributors!