Search function

[CharlineOe]

Value proposition

As a User of the DIY app I want to be able to search for keywords In order to find a specific project/topic

Description

Acceptance criteria

• [ ] On the overview and favorite page the user can access a search field (via magnifying glass icon)
• [ ] User can entering keywords in the search field
• [ ] Upon entering a keyword, a list of relevant projects or topics is displayed, matching the user's search query.
• [ ] Users have the option to clear their search results by clicking an "X" button, after which all projects or topics are displayed again, resetting the search functionality.
• [ ] Fuzzy Search is implemented and working

Tasks

• [x] create feature branch feature/search
• [x] Implement Fuzzy Search (Timebox 4h, after 4h use the following instructions instead and add additional US FuzzySearch for later)
• [x] add a button with magnify glass icon, - display option for search and filter
• [x] open filter modal if selected by user
• [x] display search component if selected by user
• [x] display search results based on user input
• [x] clear search results on clicking "X-Button" => display all projects

[JessicaLoers]

hey team - well done ✨

Here're some thoughts to improve your Story.

The ACs could be a little more detailed and explicit, like....

• [ ] A search field (indicated by a magnifying glass icon) is available on both the overview and favorites pages of the app.
• [ ] Users can enter keywords into the search field to initiate a search.
• [ ] Upon entering a keyword, a list of relevant projects or topics is displayed, matching the user's search query.
• [ ] Users have the option to clear their search results by clicking an "X" button, after which all projects or topics are displayed again, resetting the search functionality.

⚠️ Please note the following: Depending on the complexity of the search functionality you wish to offer a Fuzzy Search could be beneficial. For example if you want your search feature to be tolerant of typos and slight variations in the search query, making the search experience more user-friendly and robust. One of the most popular libraries for implementing fuzzy search in JavaScript is Fuse.js

But it's absolutely fine to implement a simple search function as a first step that can be improved in a later user story. Our motto is: Make it work, make it efficient, make it nice.