Here's a README.md template that you can use for your project. This template covers all the guidelines provided for Task 3: Design a Weather Forecast Dashboard.

Task 3: Weather Forecast Dashboard

Overview

This project is a weather forecast dashboard designed to provide users with real-time weather information. The dashboard features daily weather forecasts and other relevant meteorological data.

Repository Information

• Repository Name: wasserstoff-FullstackInternTask
• Public URL: GitHub Repository

Project Setup

Prerequisites

• Node.js
• Git

Steps to Run the Project

1. Clone the Repository

   git clone https://github.com/MridulTi/wasserstoff-FullstackInternTask.git .

2. Install Dependencies

   cd frontend
   npm install
   cd..
   cd backend
   npm install

3. Run the Development Server

   1. cd frontend
     npm run dev
   2. cd backend
     npm run dev

4. Open in Browser Open your browser and navigate to http://localhost:3000.

API Endpoints

Here are the key API endpoints utilized in the project:

• /api/v1/weather/current-weather: Fetches current weather data for a specified location.
• /api/v1/weather/weekly-forecast: Fetches the 7-day weather forecast for a specified location.
• /api/v1/weather/daily-forecast: Fetches the today's weather forecast for a specified location.
• /api/v1/weather/hourly-forecast: Fetches the horly weather forecast for a specified location.

For detailed API documentation, refer to the Postman Collection.

Frontend

The frontend of this project is built using React. The dashboard features a user-friendly interface, providing weather information, including temperature, humidity, wind speed, and other relevant data.

Postman Collection

If you are not building the frontend, you can test the API endpoints using the Postman collection.

• Collection URL: Weather Forecast API Collection

Video Explanation

A short video explaining the approach taken to solve the problem has been recorded. It covers the thought process, design decisions, and implementation details.

• Video URL: Approach and Solution

Comments and Documentation

The code is well-commented to provide clarity on various functions and logic throughout the project. Please refer to the comments in the codebase for in-depth explanations.

Contact Information

If you have any questions or need further assistance, feel free to reach out:

• Name: Mridul Tiwari
• Email: mridultiwari2002@gamil.com

---

Thank you for reviewing this project. Feedback is always appreciated.