@audius/stems

An audio-forward React Component library built with ❤️ from the team @Audius.

🚧 Actively under development, not recommended for production use! 🚧

Installation

Install @audius/stems required peer dependencies:

npm install --save bn.js classnames@2.2.6 lodash@4.17.20 moment@2.24.0 prop-types react react-dom react-spring@8.0.27

Then install @audius/stems

npm install --save @audius/stems

Usage

import React from 'react'
import { Button } from '@audius/stems'

import '@audius/stems/dist/stems.css'

const App = () => {
  return (
    <Button text='Hello World!' />
  )
}

Optional: You may also wish to include the Avenir font, which is provided as a css file

import '@audius/stems/dist/avenir.css'

Development

Run storybook:

npm run storybook

Run the example app (docs site):

cd example
npm start

Run local Stems against another repo:

git clone [e-mail]:AudiusProject/stems.git
# Create a system link
npm link

# You may need this line so React versons don't conflict
# https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react
# npm link <other repo>/node_modules/react

npm start

<other repo> npm link @audius/stems