0.0.14-dev β’ Published 4 years ago
@ott_test/base-map v0.0.14-dev
OTP-UI React Component Library
Description
React component library, which can be used to build trip planner webapps.
See:
- Examples and docs (via Storybook)
- Current npm releases
- A reference implementation of otp-ui -- IMPORTANT NOTE: otp-ui use in otp-rr is a WIP / TBD
Getting Started
git checkout https://github.com/opentripplanner/otp-ui.git
yarn install
yarn dev # (opens storybook to running component library on localhost:5555)
Stack
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 preppublish
- 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.npx lerna changed
- Show which packages have changed.npx lerna diff
- Show specifically what files have cause the packages to change.npx lerna create <packageName>
- Creates new package and walks through setting up package.json
Lerna Publish to NPM
Some commands you might need to execute for lerna to publish to npm:
npm whoami
npm login
npm config set access public
npx lerna changed
npx lerna publish # option 1: default publish
npx lerna publish 0.0.x --force-publish=* # option 2: publish all components to version X
yarn deploy-storybook
0.0.14-dev
4 years ago