Lilinhao.li

Accessibility-report.md

@@ -0,0 +1,39 @@
+# Accessibility Report
+
+
+## Principles of Universal Design
+Our project hopes to follow as many principles of Universal design as possible. A comprehensive analysis of each principle is located below. 
+
+### Principle 1: Equitable Use
+The Software displays a Map of the city chosen and nearby cities to be more accesible to those that prefer images over text. 
+The UI also has the information in a chart form, with words spaced out to be more accessible to those that have trouble processing large chunks of information. 
+### Principle 2: Flexibility in Use
+The software aims to be as perceptible as possible by allocating a conversion button for those that may not understand metric units. 
+### Principle 3: Simple and Intuitive Use
+The UI is very simple as all the user has to do is type in a city in a search bar or press clearly labelled buttons, this is helpful for those that may not have much experience with our software.
+### Principle 4: Perceptible Information
+As mentioned before, the information uses varying modes of displaying information. Specifically, it is displayed in a chart on the right and a map is provided on the left for ease of
+use.  
+### Principle 5: Tolerance for Error
+Nothing done on the software is permanant as all changes can be reversed. Cities can be retyped if spelt wrong, units can be converted infinitly and all other features change automatically to support the user. 
+### Principle 6: Low Physical Effort
+The concept of physical effort is not much applicible to the software is online. However, the software only requires the user to type in the city name. 
+All other calculations are done in the backend or done using simple buttons. The use of buttons requires very little effort. 
+### Principle 7: Size and Space for Approach and Use
+This concept is not much applicable to our software design. However, our program is coded in java and can be run on any platform that contains the JVM. This is especially useful for 
+users with disabilities that require unique hardware. For example, since the code can run on laptops, the user can plug in an accesible keyboard and still use our software. 
+
+
+## The Market
+Realistically the most likely demographic for this project is those that are creating vacation plans, i.e travellers. Cultivating a list of cities nearby and using the software to 
+compare the weather of those cities
+may be a feature most relevant to those planning what cities to go to. For example, if you were vacationing in Mykonos and it suddenly started raining before you went to the beach, you 
+may use the application to find cities around you that may not be raining. 
+The Weather Alerts feature is another one that may help travel planners plan for the weather as avoidng places with severe weather hazards is preferable. 
+
+## Demographic Usage
+Since our UI only comes in smoall text on a default white background, the software is less likely to be used by those with visual impairments. Specifacally, people that are far sighted 
+or those that struggle to concentrate in low contrast settings. A possible feature to add can be the use of another API to read out information and to implement a high contrast 
+background. Asides from that, our software is easy to use due to the use of buttons and simple instructions and the conversion buttons. Important information such as alerts are clearly 
+presented in a bold manner and unit conversion is implemented to allow users from all over the world to use our software. I dont see why any other demographics would be less likely to 
+use this programs less. 

README.md

@@ -1,36 +1,75 @@
-# Note Application
+# WeatherWizard
+Authors and Contributors: Annie B.,Sophie L., Linhao L., Harmanpreet S. and Ishayu S.
 
-This is a minimal example demonstrating usage of the
-password-protected user part of the API used in lab 5.
+WeatherWizard aims to provide users with a friendly accessible application to access Weather around the World. It can be used to plan trips, figure out historical weather data for projects and more. Many users have to use several tabs to compare weather in different destinations and this application aims to help users plan travel. 
 
-You can find more information about the API endpoints in
-[the documentation](https://www.postman.com/cloudy-astronaut-813156/csc207-grade-apis-demo/documentation/fg3zkjm/5-password-protected-user).
+## Table of Contents
+1. [Features of Software](#features-of-software)
+2. [API](#api)
+3. [Installation](#installation)
+   - [Common Installation Issues](#common-installation-issues)
+4. [Usage Guide](#usage-guide)
+5. [License and Copyright Notice](#license-and-copyright-notice)
+6. [Contributions](#contributions)
+7. [Feedback](#feedback)
+8. [Accessibility](#accessibility)
+9. [Want to Know More?](#want-to-know-more)
 
-If your team is considering an application for which it would be convenient to
-store data in something like a database, you may find that the API calls demonstrated
-here will be useful in your project, as this will allow you to store
-an arbitrary JSON object associated with a username and password.
+## Features of Software.
+As mentioned previously the broad overarching sense of purpose lays in the ease in checking weather. The Software provides general information about the weather, humidity, windspeed, Visibility and sky condition. Asides from that, the application has the following features. 
+* Accessible Map: The Software uses the JXMAP library to display a map that shows the location of the city. 
+* Unit Conversion: The Software supports both Metric and Imperial Unit Conversion.
+* Weather Alerts: The Software displays Emergency Alerts regarding the weather including but not limited to Flooding, Tornado, Snow Storms and etc.
+* Nearby Cities: The Software displays a list of cities close to the main destination. 
+* Comparisons: The Software allows for users to select up to two cities at a time to compare weather.
+* Search Historic Weather: The Software allows for the User to search for historic weather.
 
-In this application, a single note has a name (the "username" in terms of the API) and the note
-can be read by anyone who knows the name — but only edited by someone who
-knows the password for it.
+## API.
+The OpenWeather 3.0 API is called by city name to recieve weather information regarding temperature, humidity, windspeed & etc. 
+   https://openweathermap.org/api/one-call-3
+
+The JXMAP library is used to produce a map to aid in the accesability of the software.
+msteiger/jxmapviewer2: JXMapViewer2 
 
-You can see the documentation in the various files for more information.
+## Installation.
+The steps for Installation are as follows. 
+1. Download the Java Development Kit (JDK) 17+, Apache Maven 3.8+ and an IDE of your choice (the instructions use Intellij).
+2. Clone the repository by Opening IntelliJ and selecting File, then  New,  then Project from Version Control. Choose Git and in this drop box paste the repository link (press the green code button on Github to copy the repository link). Choose a directory of your choice and click clone.
+3. Configure the project by going to File > Project Structure > Project Settings > Project. Here you should see what SDKs are setup. If you do not see the SDKs mentioned in step one, add them.
+4.  Go to https://openweathermap.org/api/one-call-3 and obtain your own API key and replace with the one provided. Make sure to wait at least 7 hours as the API key activates several hours after creation.
 
-## Testing
+### Common Installation Issues
+* "Maven dependencies not resolved"
+  Go to the Maven Tool window and press Reload All Maven Project. 
+*  "Java Version Mismatch"
+  Go to File > Project Structure > Project and download Java 17. 
+*  "The Map is not Visible"
+  Ensure that JXMapViewer2 library is downloaded in the pom.xml file, if not add it.
 
-The repo also includes an example of a use case interactor test, as well as
-an example of an end-to-end test which automates button clicks and inspects
-the contents of the actual views. This is something we discussed in the lectures
-about testing in CA but had not provided a code example of before. Note, one
-could also inspect the contents of the ViewModel objects instead when testing
-CA to make a similar test which would be less dependent on the details of the
-specific UI implementation.
+## Usage Guide
+To use the software, navigate to the MainApplication file in Intellij located under the App folder.  ( Src > Main > Java > App > MainApplication) and press the run file button. 
 
-## Project Starter Code
+## License and Copyright notice.
+This project is protected by Canadian copyright law. Under the Copyright Act (RSC 1985, c. C-42), the content of this repository, including but not limited to source code, documentation, and other original works, is automatically protected by copyright as soon as it is created and fixed in a tangible form. All rights to the work are reserved to the original author(s) unless explicitly stated otherwise.
 
-Your team may choose to use this repo as starter code for your project. You could
-also use the lab 5 code — or start from an empty repo if your team prefers.
+## Contributions
+Contributions to this code are welcomed. If you would like to contribute, please ensure that the original authors are properly credited, you are welcome to create a pull request, that will be reviewed by the authors of this work. 
 
-If you choose to use one of the repositories we have provided, you can either make
-a fork of it or copy the subset of code you want into a completely new repository.
+To make a fork on Github, press the fork button located across from the Project Name.
+
+<img width="1029" alt="image" src="https://github.com/user-attachments/assets/8fbb1531-0ba8-4f53-a524-2f6960f47031">
+
+
+## Feedback
+Any and all feedback on this project is much appreciated. To provide your feedback, please visit the following typeform.
+
+[Feedback Form](https://3g4dr8ponwb.typeform.com/to/XWR9pbZm)
+
+If an email is provided, our team will contact you within 24 hours.
+
+## Accessibility
+The project aims to be accessible to everyone as much as possible and thus has several features to ensure such. For more information, please check out our accessibility report by navigating to the accessibility-report.md file. 
+
+## Want to know more?
+If you would like to know more please check out our presentation.
+[Link to the Presentation](https://docs.google.com/presentation/d/1UF4Ibt3WqdovrlT1XoJV6r2-A5ybwz8jJzVqMy94D5k/edit?usp=sharing)

pom.xml

@@ -28,6 +28,29 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.jxmapviewer</groupId>
+            <artifactId>jxmapviewer2</artifactId>
+            <version>2.8</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.8.1</version>
+            <scope>test</scope>
+        </dependency>
+
+
     </dependencies>