README.md

🎸 Instant Guitar Chord Positions Search, powered by Typesense

Tech Stack

• Typesense
• Nuxt. There is also a NextJS version
• Vue-instantsearch and Typesense Instantsearch Adapter
• Typescript
• Cypress

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.

Repo structure

• components/ contains UI components
• scripts/ contains file to index data from scripts/data into Typesense

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/phiHero/typesense-guitar-chords-nuxt.git

cd typesense-guitar-chords-nuxt

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 required env variables in nuxt.config.ts