anthonyvngo / happy-here Goto Github PK

⚙️ Feature

What capability will users have when this feature is merged?

📐 Functionality

A description of how the application will work from the perspective of the user.

🖼️ Wireframes

Wireframe screenshot(s) of what the app should look like when it is complete.

✅ Task List

Commit checklist for tasks needed to complete the feature.

• create alternate view to display a list of favorited & skipped cities
• set up data model to contain favorited or skipped city
• ensure no duplicated data can be added
• ensure that city is in only one category
• populate favorited & skipped cities display
• set up local storage to ensure favorites and skips data persists

⚙️ Feature

Users will have the capability to begin their search for cities after this feature has been merged

📐 Functionality

While on the main screen or "search" screen, users will be able to initiate the search for city quality of life scores by first starting with the ability to search for cities.

🖼️ Wireframes

✅ Task List

• add a search bar for user inputs
• ensure search function for cities work

⚙️ Feature

Users will have the capability to view quality of life statistics of the searched city

📐 Functionality

After the user begins their search for a city on the main / search page, an alternative view with the city's quality of life score will appear. At this stage, the user will be able to review the stats for the searched city

🖼️ Wireframes

✅ Task List

• display searched city name
• create a list to showcase relevant statistics
• include overall score for the city

⚙️ Feature

User can store cities as favorited or skipped cities by clicking on the corresponding buttons

📐 Functionality

After the user has began the search and reviewed the city scores, they will be able to store the cities to reference later as a favorited or skipped city

🖼️ Wireframes

✅ Task List

• create favorite and skip buttons
• add event handlers to the favorite and skip buttons to store data
• add event handlers to return to the search page

⚙️ Feature

Users will have the capability to remove items from their favorited or skipped cities lists

📐 Functionality

After the user has made their search, reviewed city scores, and stored cities in either favorited or skipped lists, they will be able to remove unwanted cities from their corresponding lists by double-tapping on the list item

🖼️ Wireframes

✅ Task List

• add an event handler to the list items' parent container to remove the corresponding items
• make sure the data is also removed from the data storage object if any

Clean Up

• Remove all buttons and placeholders that do not serve the functionality of the feature.
• Remove all console logs.
• Remove all commented out code.
• Remove all CSS properties that have no effect.
• Check all code for proper formatting and indentation.
• Confirm that there are no errors in the console while using the application.
• Confirm that all previous functionality still works without errors.
• Confirm that the user interface looks natural on both mobile and desktop screens.
• Create GIFs of the feature being used on both mobile and desktop screen sizes for inclusion in Pull Request.