akash-network / akash-network/console
Integrate minisearch to improve searching over templates in console
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 264
- Forks
- 94
- Avg merge
- 18h 49m
- Merged PRs (30d)
- 297
Description
Why
From the code, it looks like we may need this optimization because someone implemented search over search terms instead of just searching a substring in a template description. MiniSearch is a tiny but powerful in-memory fulltext search engine written in JavaScript. It is respectful of resources, and it can comfortably run both in Node and in the browser.
Key benefits
- improved UX for our users when searching templates (this library uses inverted index to search for terms).
What
Integrate minisearch to improve searching over templates in console.
Acceptance
- use minisearch to search over templates
Validate the need
- Do we have/need client searching capabilities on other pages?
- Additional 5.8kB of min+gzipped code
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in apps/deploy-web/src/components/templates/TemplateGallery.tsx around line 58 and review the current template search behavior. Read MiniSearch's usage documentation, then integrate it for template searching; done means the console searches templates with MiniSearch and the acceptance criterion is met.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- frontend, search, web-dev
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100