Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #60

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 2 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Weather Forecast Application

## Objective
This project is a weather forecast application built using React.js that fetches and displays weather data from a public API. It emphasizes reusable components, API integration, state management, and a user-friendly interface.
This project is a weather forecast application built using React.js that fetches and displays weather data from a public API. The application emphasizes reusable components, API integration, state management, and a user-friendly interface.

## Features
- **Current Weather Display**: Shows the current weather for a default city (e.g., New York) with components for city name, temperature, weather condition, and an icon.
Expand All @@ -17,7 +17,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.
Expand All @@ -28,33 +28,4 @@ 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:**:
```bash
npm run dev
5. **Create a .env File:**:
```bash
VITE_API_KEY=your_api_key_here

#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)

## Contributing
Contributions are welcome! If you'd like to contribute, please submit a pull request or open an issue.

## License
This project is licensed under the MIT License.

## Acknowledgements
Thanks to OpenWeatherMap for providing the weather data API.