README.md

🎸 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 & 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

/
├── 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

git clone https://github.com/typesense/showcase-guitar-chords-search-remix.git

cd showcase-guitar-chords-search-remix

npm i

Start typesense server

npm run start:typesense # or: docker compose up

Index data into typesense

npm run index:typesense

Start the dev web app

npm run dev

Open http://localhost:3000/ to see the app ✌️

Deployment

Set env variables to point the app to the Typesense Cluster

PUBLIC_TYPESENSE_SEARCH_ONLY_API_KEY=xxx
PUBLIC_TYPESENSE_HOST=xxx.typesense.net
PUBLIC_TYPESENSE_PORT=443
PUBLIC_TYPESENSE_PROTOCOL=https