Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.02 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.02 KB
Raw

Data Catalog Components

A set of React components to facilitate the creation of Open Data Catalogs with React.

Viewing the Components

This project utilizes storybook to document the available components.

To see the available components:

  1. clone this repo
  2. Install the dependencies with npm:
    1. cd data-catalog-components
    2. npm install
  3. Start storybook
    1. npm run storybook

Publishing

  1. Review exports in index.js
  2. Increase version in package.json
  3. run npm run lib
  4. run npm publish

Publish to Github Pages

  1. run npm run prepublish; npm run deploy-storybook

Testing Components without Updating NPM Package

To test or use the components from a github branch:

  1. Create new branch locallly
  2. Remove lib from .gitignore
  3. Run npm run lib
  4. Push lib folder and .gitignore to your branch
  5. Add branch to package.json by running npm install --save interra/data-catalog-components#MY-BRANCH
  6. Profit