OTP-UI React Component Library

A Monorepo with multiple packages and a shared build, test, and release process.

• 🐉 Lerna  - The Monorepo manager
• 📦 Yarn Workspaces  -  Sane multi-package management
• 🚀 React  -  JavaScript library for user interfaces
• 💅 styled-components  -  CSS in JS elegance
• 🛠 Babel  -  Compiles next-gen JavaScript
• 📖 Storybook - UI Component Environment
• 🃏 Jest  -  Unit/Snapshot Testing

Usage

• yarn dev - This starts Storybook for viewing all the components locally.
• yarn bootstrap - This installs all of the packages and links dependent packages together.
• yarn build - This babelfies all of the packages and creates /lib folders for each one.
• yarn unit - Run jest unit tests.
• yarn coverage - Shows jest unit coverage.

Lerna

• lerna changed - Show which packages have changed.
• lerna diff - Show specifically what files have cause the packages to change.
• lerna create <packageName> - Creates new package and walks through setting up package.json

Linking

When linking inside of the Monorepo, everything works as expected. If you are trying to consume packages from this Monorepo in a different application locally, using npm link or yarn link does not work as expected. However, we have a workaround for the time being.

1. Run yarn build
2. Run yarn dev
3. Change the package.json of the consumer from $YOUR_PACKAGE_NAME (which lives inside the monorepo) to file:./../monorepo/packages/$YOUR_PACKAGE_NAME
4. Run rm -rf node_modules && yarn in the consumer
5. 🎉

Contributing

All formatting and linting should be taken care of for you using stylelint, ESLint, and Prettier. You should also consider installing an extension for CSS syntax highlighting.

• vscode-styled-components
• webstorm-styled-components
• Other IDEs