ytel-ui-comp-lib
v0.0.2
Published
Ytel UI React component library
Downloads
4
Readme
Ytel UI Component library
Maintainer: Wes W.
The UI React component library to supplement the Ytel Engagement Platform/Interact UI.
Ytel UI Component Lib documentation
To run component library locally
To run locally, do the following:
- Create a fork and clone the project
npm install
- Run
npm link
to auto-run the "prepare" script in package.json - In consumer project/app, run
npm link ytel-ui
. This will create a symbolic link from the component library src to the consumer projecct. - Import components with pattern
import { ComponentName } from 'ytel-ui';
To run documentation locally
Documentation for component library currently uses docz which provides a few helpful out-of-the-box components, such as auto-generate a props table and "playground" component for rendering a component. Docz uses mdx (a flavor of markdown) for rendering JSX inside of markdown. Any .mdx file is a documentation file for a corresponding component.
- Create a fork and clone the project (skip if already done so)
npm install
- Run
npm run docs:dev
to build documentation - Run
npm run docs:build
for a production-ready build - Run
npm run docs:copy
to copy production docs build fromdocs-build
directory intopublic
directory. - The .gitlab.ci.yml file already expects the public folder to be populated with the production build.
Currently, the above scripts are done by hand and not by .gitlabe.ci.yml file because docz sometimes has a tendancy to double copy the public path inside of docs-build
directory.