Adding a Searchbar Functionality for Submitty

Open
#8,115 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
php
Domain
search

Research direction

No files, tests, or entry points are named. Start by mapping how Submitty pages and user permissions are organized, then define the searchable scope and access rules before choosing an implementation; done means a global or page-level search returns relevant results without exposing inaccessible content.

Written by the indexing model from the issue text.

Description

enhancement / feature request HTML5 / VPAT / Accessibility / Screen reader question / design / discussion needed

What problem are you trying to solve with Submitty
There are a lot of pages in the Submitty application and sometimes finding something could take a lot of navigation or time and to solve this a global searchbar could be added to the Submitty which could search through whole of the application based on the certain words user has entered.

Describe the way you'd like to solve this problem
Generally the searchbar functionality works by looping through whole page and matching for indexed words with the words entered in the search bar.
Since the submitty is huge and complex we would want something more creative and smart approach for same, something like searching through the entire text that is being displayed and then showing the relevant results ; could be one approach.

Describe any potential alternatives you may try to solve the problem
Instead of a global searchbar we may even try to have indiviual searchbars for the pages that require a lot of scrolling to reach to some result .

Additional context
While searchbar is implemented , it is to be taken care off that users are shown the results that they have acess to like a student cant be shown results from the options available in creation of a gradeable.

Dominant language
PHP
Stars
793
Forks
1.1k
Avg merge
2d 16h
Merged PRs (30d)
78

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Submitty/Submitty

All issues in Submitty/Submitty

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.