Skip to content
Simple react component for guitar chord charts with audio
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
config
public
scripts
src
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package.json
testSetup.js
yarn.lock

README.md

Build Status

Guitar chord SVGs in React

Getting Started

Demo

yarn add react-guitar-chords

import React from 'react';
import GuitarChord from 'react-guitar-chords';

const MyChord = () => {
  return (
    <GuitarChord
      chordName='C major'
      frets={['x', 3, 2, 0, 1, 0]}
    />
  );
}

export default MyChord;

Development Setup

Built with create-react-library

git clone git@github.com:evan-007/react-guitar-chords.git

Install dependencies

yarn install

Start development server

yarn start

Runs the demo app in development mode. Open http://localhost:3000 to view it in the browser.

Library files

All library files are located inside src/lib

Demo app

Is located inside src/demo directory, here you can test your library while developing

Testing

yarn run test

Build library

yarn run build

Produces production version of library under the build folder.

Publish library

yarn publish

You can’t perform that action at this time.