@kevinorriss/metronome v1.0.0

Metronome

A ReactJS Metronome component inspired by Google's implementation

Prerequisites

• React ^16.9.0 - Javascript library for user interfaces

Installing

npm install @kevinorriss/metronome

Usage

Import the component

import Boilerplate from '@kevinorriss/metronome'

...

<!-- JSX -->
<div className="your-container">
    <Metronome />
</div>

Development

This repo comes with a react app for development purposes. To get started, open a terminal in the root of the project and then:

Link the component to the app

cd ./component
yarn link

cd ..
yarn link @kevinorriss/metronome

Start the app

yarn start

Start the rollup watcher

cd ./component
npm run dev

Whenever you make a change to the component code, the react app will update.

Tests

yarn test

This project uses Jest and Enzyme for its unit tests, simply run the above code to run the test suites.

If you want the tests to run during development, you will need to have rollup watching too!

Author

• Kevin Orriss - orriss.io

License

This project is licensed under the ISC License