{"id":19000448,"url":"https://github.com/typesense/showcase-guitar-chords-search-solid-js","last_synced_at":"2025-04-22T17:05:51.647Z","repository":{"id":221160193,"uuid":"753214526","full_name":"typesense/showcase-guitar-chords-search-solid-js","owner":"typesense","description":"A demo that shows how to implement Typesense in Solid.js","archived":false,"fork":false,"pushed_at":"2025-02-05T00:47:01.000Z","size":151,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-17T07:17:32.295Z","etag":null,"topics":["solidjs","typesense","typesense-showcase"],"latest_commit_sha":null,"homepage":"https://guitar-chords-search-solid-js.typesense.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typesense.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-05T17:30:49.000Z","updated_at":"2025-02-05T00:47:05.000Z","dependencies_parsed_at":"2024-05-28T23:38:25.565Z","dependency_job_id":"98154b9a-2d76-42b2-a6c3-0765c99f0ad5","html_url":"https://github.com/typesense/showcase-guitar-chords-search-solid-js","commit_stats":null,"previous_names":["typesense/showcase-guitar-chords-search-solid-js"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-solid-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-solid-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-solid-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-solid-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesense","download_url":"https://codeload.github.com/typesense/showcase-guitar-chords-search-solid-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250285662,"owners_count":21405296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["solidjs","typesense","typesense-showcase"],"created_at":"2024-11-08T18:07:15.053Z","updated_at":"2025-04-22T17:05:51.623Z","avatar_url":"https://github.com/typesense.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n 🎸 Instant Guitar Chord Positions Search, powered by Typesense - SolidJS\n\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cdiv\u003e\u003ch3\u003eOther versions\u003c/h3\u003e\u003c/div\u003e\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-nuxt-js\"\u003eNuxtJS\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-next-js\"\u003eNextJS\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-angular\"\u003eAngular 15\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-vanilla-js\"\u003eVanilla JS\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-astro\"\u003eAstro\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-solid-js\"\u003eSolidJS\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-remix\"\u003eRemix\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-svelte-kit\"\u003eSveltekit\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-qwik\"\u003eQwik\u003c/a\u003e |\n  \u003ca href=\"https://github.com/typesense/showcase-guitar-chords-search-react-native\"\u003eReact Native\u003c/a\u003e\n\u003c/div\u003e\n\n## Tech Stack\n\n- \u003ca href=\"https://github.com/typesense/typesense\" target=\"_blank\"\u003eTypesense\u003c/a\u003e\n- SolidJS\n- Typescript\n- [typesense-instantsearch-adapter](https://github.com/typesense/typesense-instantsearch-adapter) \u0026 instantsearch.js\n- Cypress\n\nAll make for a blazingly fast search experience 🔥🔥🔥\n\nThe guitar chord dataset \u0026 chord svg generation is from \u003ca href=\"https://github.com/tombatossals/chords-db\" target=\"_blank\"\u003etombatossals\u003c/a\u003e which contains 2141 chord shapes of 552 chords.\n\n## Project Structure\n\n```bash\n/\n├── cypress/\n│   └── e2e tests...\n├── scripts/\n│   ├── data/\n│   │   ├── guitar.json\n│   │   └── schema.json\n│   └── indexTypesense.ts # script that index data from guitar.json into typesense server\n└── src/\n    ├── components/\n    │   └── UI components...\n    ├── hooks/\n    │   └── createInstantsearch.tsx # run instantsearch.js on mount\n    ├── utils/\n    │   ├── reactChord.ts # draw guitar chord svg\n    │   └── typesense.ts # typesense-instantsearch-adapter config\n    └── App.tsx # guitar chords search\n\n```\n## Development\n\nTo run this project locally, make sure you have docker and nodejs, install the dependencies and run the local server:\n\nInstallation\n\n```shell\ngit clone https://github.com/typesense/showcase-guitar-chords-search-solid-js.git\n\ncd showcase-guitar-chords-search-solid-js\n\nnpm i\n```\n\nStart typesense server\n\n```shell\nnpm run start:typesense # or: docker compose up\n```\n\nIndex data into typesense\n\n```shell\nnpm run index:typesense\n```\n\nStart the dev web app\n\n```shell\nnpm run dev\n```\n\nOpen http://localhost:3000 to see the app ✌️\n\n## Deployment\nSet env variables to point the app to the Typesense Cluster\n\n```env\nVITE_TYPESENSE_SEARCH_ONLY_API_KEY=xxx\nVITE_TYPESENSE_HOST=xxx.typesense.net\nVITE_TYPESENSE_PORT=443\nVITE_TYPESENSE_PROTOCOL=https\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-solid-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-solid-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-solid-js/lists"}