Merge pull request #4 from A-Samod/develop

PRL-4.0-Readme Changes

README.md

@@ -1,3 +1,65 @@
 # Student ID : COBSCCOMP4Y222P-011
 
+# WEATHER MAP FRONTEND
 
+This project is a frontend application built with React that displays weather data on a map for 24 districts in Sri Lanka. The weather data includes temperature, humidity, air pressure, and the latest updated date. The data is synced from a backend API.
+
+## DEMO
+
+You can find a live demo of the application [here](https://avishka.tech/).
+
+
+## FEATURES
+
+- Displays weather data on a map for 24 districts in Sri Lanka.
+- Shows temperature, humidity, air pressure, and the latest updated date.
+- Includes a search option to find weather data for specific districts.
+
+1. Weather Map:
+
+   ![Weather Map](./README/weather_map.png)
+
+2. Weather Details:
+
+   ![Weather Details](./README/weather_data.png)
+
+3. Search Functionality:
+
+   ![Search Functionality](./README/weather_map_search.png)
+
+## Installation
+
+1. Clone the repository:
+
+```
+git clone https://github.com/A-Samod/weather-api-frontend
+```
+
+2. Navigate to the project directory:
+
+```
+cd weather-api-frontend
+```
+
+3. Install dependencies:
+```
+npm install
+```
+
+4. Start the development server:
+```
+npm start
+```
+5. Open http://localhost:3000 to view it in the browser.
+
+## Backend Repository
+
+The backend repository for this project can be found [here](https://github.com/A-Samod/weather-api-backend).
+
+## UML SEQUENCE DIAGRAM
+
+ ![SEQUENCE DIAGRAM](./README/sequence_diagram.png)
+
+ ## CLOUD ARCHITECTURE
+
+ ![CLOUD ARCHITECTURE](./README/cloud_architecture.png)