dgading / data-catalog-components

https://getdkan.github.io/data-catalog-components

Data Catalog Components

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

Working locally

To develop locally against a working version of the data-catalog-frontend, you will need to do the following steps.

1. Run rm -rf node_modules && npm install in the data-catalog-frontend repo.
2. Run rm -rf node_modules && npm install in the data-catalog-components repo.
3. Run npm link in this repo (data-catalog-components), this will create a symlink to your global npm registry.
4. Run npm link <relative path to dkan frontend>/node_modules/react in this repo to connect the component library to the frontend's react folder.
5. Run npm link @civicactions/data-catalog-components in the data-catalog-frontend repo. This will make it so when you run npm install it will symlink the node_modules folder to the global symlink instead of downloading the library from npm.
6. Run gatsby develop in the data-catalog-frontend repo.
7. In this repo, run npm run lib:watch to work on components or npm run css:watch to work on just CSS changes. Babel will now watch any commands you make to React components in this folder and rebuild the library. When a rebuild happens it will cause the frontend Gatsby development server to rebuild and show your changes.

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

Docz preview

• Comment out base: '/data-catalog-components' from doczrc.js
• Run npm run docz:serve then visit http://localhost:3000.

Publishing

1. Review exports in index.js
2. Increase version in package.json
3. run npm login
4. run npm publish --access public

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 getdkan/data-catalog-components#MY-BRANCH
6. Profit