Brown University Components

Components for building React-based applications at Brown University.

---

Usage

1. Install packages

Brown University Components

// npm
npm i BrownUniversity/brown-university-components#semver:^2.0.0

// yarn
yarn add git+https://github.com/BrownUniversity/brown-university-components.git#^2.0.0

Required Peer Dependencies

These libraries are not bundled with Brown University Components and are required at runtime:

• brown-university-styles
• react
• styled-components

2. Import styles from Brown University Styles

---

Documentation

The documentation is available at https://brownuniversity.github.io/brown-university-components/.

---

Development

Install dependencies:

npm install

Run examples at http://localhost:8080 with storybook:

npm start

Run tests:

npm test

Run tests with code coverage:

npm test:coverage

Run tests with code coverage and open report:

npm test:coverage:open

Watch tests:

npm run test:watch

---

Deployment

To publish a new version, do the following:

1. Bump version in package.json and package-lock.json
2. Bump version in README.md install instructions (for major and minor version bumps only)
3. Update CHANGELOG.md
4. npm run build
5. Commit changes
6. Tag new version
7. Push master and tags to all remotes