Skip to content
Branch: master
Clone or download
Latest commit 636fe05 Jul 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook Cleanup 4.0.1 (#45) Jul 3, 2019
src Cleanup 4.0.1 (#45) Jul 3, 2019
stories Cleanup 4.0.1 (#45) Jul 3, 2019
.babelrc Upgrade storybook to 5.0, babel 6 to babel 7 (#25) Mar 11, 2019
.eslintrc.json Reconfiguring linting. Jan 22, 2019
.gitignore Default theme. Jan 3, 2019
README.md Update README.md May 24, 2019
package.json Cleanup 4.0.1 (#45) Jul 3, 2019

README.md

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
You can’t perform that action at this time.