https://github.com/typesense/showcase-guitar-chords-search-remix
A demo that shows how to implement Typesense in a Remix app
https://github.com/typesense/showcase-guitar-chords-search-remix
remix typesense typesense-showcase
Last synced: about 1 month ago
JSON representation
A demo that shows how to implement Typesense in a Remix app
- Host: GitHub
- URL: https://github.com/typesense/showcase-guitar-chords-search-remix
- Owner: typesense
- License: apache-2.0
- Created: 2024-02-05T17:29:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-12T15:42:25.000Z (6 months ago)
- Last Synced: 2025-04-17T07:17:34.244Z (about 1 month ago)
- Topics: remix, typesense, typesense-showcase
- Language: TypeScript
- Homepage: https://guitar-chords-search-remix.typesense.org
- Size: 183 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🎸 Instant Guitar Chord Positions Search, powered by Typesense - Remix
Other versions
NuxtJS |
NextJS |
Angular 15 |
Vanilla JS |
Astro |
SolidJS |
Remix |
Sveltekit |
Qwik |
React Native
## Tech Stack
- Typesense
- Remix
- Typescript
- [typesense-instantsearch-adapter](https://github.com/typesense/typesense-instantsearch-adapter) & react-instantsearch
All make for a blazingly fast search experience 🔥🔥🔥
The guitar chord dataset & chord svg generation is from tombatossals which contains 2141 chord shapes of 552 chords.
## Project Structure
```bash
/
├── scripts/
│ ├── data/
│ │ ├── guitar.json
│ │ └── schema.json
│ └── indexTypesense.ts # script that index data from guitar.json into typesense server
└── app/
├── components/
│ └── GuitarChordsSearch
│ ├── GuitarChordsSearch.tsx # react-instantsearch setup
│ └── ...
├── routes/
│ └── _index.tsx # guitar chords search
└── utils/
└── typesense.ts # typesense-instantsearch-adapter config
```
## Development
To run this project locally, make sure you have docker and nodejs, install the dependencies and run the local server:
Installation
```shell
git clone https://github.com/typesense/showcase-guitar-chords-search-remix.git
cd showcase-guitar-chords-search-remix
npm i
```
Start typesense server
```shell
npm run start:typesense # or: docker compose up
```
Index data into typesense
```shell
npm run index:typesense
```
Start the dev web app
```shell
npm run dev
```
Open http://localhost:3000/ to see the app ✌️
## Deployment
Set env variables to point the app to the Typesense Cluster
```env
PUBLIC_TYPESENSE_SEARCH_ONLY_API_KEY=xxx
PUBLIC_TYPESENSE_HOST=xxx.typesense.net
PUBLIC_TYPESENSE_PORT=443
PUBLIC_TYPESENSE_PROTOCOL=https
```