Skip to content

@BrownUniversity Brown University

brown-react-library / 1.0.30

brown-react-library 1.0.30

Install from the command line:
Learn more about npm packages
$ npm install @brownuniversity/brown-react-library@1.0.30
Install via package.json:
"@brownuniversity/brown-react-library": "1.0.30"

About this version

Brown React Component Library

To install in a React based project

  1. add to the root of your project a .npmrc file
  2. to that new .npmrc file add the line @BrownUniversity:registry=https://npm.pkg.github.com/
  3. install the library with yarn add @BrownUniversity/[email protected] (update the version number to the latest in the repo)

To publish a new version of the package

  1. Test and verify all of the new components and changes
  2. run yarn build to compile the code
  3. run yarn publish - increment the version number
  4. Good work, enjoy a nice cup of coffee.

To add a component to the library

  1. cd into this directory brown-react-library
  2. run yarn init-component "componentName" NOTE - name your new component in camelCase
  3. edit the files in src/components_name basic files for the component, test & storybook will have been automatically generated.
  4. run yarn start to have a development preview of your component as you work on it.

Publishing updated storybook docs

Documentation site deployed via GitHub Actions to https://studious-parakeet-7b772591.pages.github.io/ when changes are merged into the main branch of the repo. Automation is a very good thing.

Details

Assets

  • brown-react-library-1.0.30.tgz

Download activity

  • Total downloads 99
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all