{"id":19000445,"url":"https://github.com/typesense/showcase-guitar-chords-search-angular","last_synced_at":"2025-04-22T17:05:54.856Z","repository":{"id":217497942,"uuid":"743752122","full_name":"typesense/showcase-guitar-chords-search-angular","owner":"typesense","description":"A demo that shows how to implement Typesense in an Angular app","archived":false,"fork":false,"pushed_at":"2024-05-28T20:40:23.000Z","size":586,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-17T07:17:31.582Z","etag":null,"topics":["angular","angular-instantsearch","instantsearch","typesense","typesense-instantsearch-adapter","typesense-showcase"],"latest_commit_sha":null,"homepage":"https://guitar-chords-search-angular.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-01-15T22:57:41.000Z","updated_at":"2024-07-12T18:15:07.000Z","dependencies_parsed_at":"2025-04-16T22:01:13.348Z","dependency_job_id":"d6c18b80-68e0-469f-91ec-19bc2f18d7df","html_url":"https://github.com/typesense/showcase-guitar-chords-search-angular","commit_stats":null,"previous_names":["typesense/showcase-guitar-chords-search-angular"],"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-angular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-angular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-angular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fshowcase-guitar-chords-search-angular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesense","download_url":"https://codeload.github.com/typesense/showcase-guitar-chords-search-angular/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":["angular","angular-instantsearch","instantsearch","typesense","typesense-instantsearch-adapter","typesense-showcase"],"created_at":"2024-11-08T18:07:15.006Z","updated_at":"2025-04-22T17:05:54.836Z","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 - Angular\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- Angular 15\n- Typescript\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├── 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│   └── app/\n│       ├── UI components...\n│       └── app.component.ts # guitar chords search\n└── writeEnvVariables.ts # util script to write env variables at build time\n```\n\n## Development\n\nTo run this project locally, make sure you have docker and nodejs.\n\nInstallation\n\n```shell\ngit clone https://github.com/typesense/showcase-guitar-chords-search-angular.git\n\ncd showcase-guitar-chords-search-angular\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\nGenerate angular env variables\n\n```shell\nng generate environments\n```\n\nThen add this to your `src/environments/environment.development.ts`\n\n```typescript\n// change them if you want to use Typesense cloud\nexport const environment = {\n  PUBLIC_TYPESENSE_SEARCH_ONLY_API_KEY: null,\n  PUBLIC_TYPESENSE_HOST: null,\n  PUBLIC_TYPESENSE_PORT: \"443\",\n  PUBLIC_TYPESENSE_PROTOCOL: \"https\",\n};\n```\n\nStart the dev web app\n\n```shell\nng serve\n```\n\nOpen http://localhost:4200/ to see the app ✌️\n\n## Deployment\n\nSet env variables to point the app to the Typesense Cluster\n\n```env\nPUBLIC_TYPESENSE_SEARCH_ONLY_API_KEY=xxx\nPUBLIC_TYPESENSE_HOST=xxx.typesense.net\nPUBLIC_TYPESENSE_PORT=443\nPUBLIC_TYPESENSE_PROTOCOL=https\n```\n\nThe file `writeEnvVariables.ts` will automatically load them into `src/environments` for the angular app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-angular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-angular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fshowcase-guitar-chords-search-angular/lists"}