npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@civicactions/data-catalog-components

v1.18.0

Published

React Components for Open Data Catalogs.

Downloads

485

Readme

Data Catalog Components

GetDKAN Maintainability Test Coverage

A set of React components to facilitate the creation of Open Data Catalogs with React. This library is powered by Parcel.

Local Development

For local development, we recommend using npm workspaces. Once you have a workspace directory, install this library inside your workspace along any Open Data downstream sites you wish to work on.

In the root folder for this project, run npm run watch to build local code. Ensure the upstream is using the same version number located in package.json of this repo. Start the upstream site locally as well, and it should load local code from this repo as the dependency. Parcel also provides hot rebuilding while watch is running.

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 dist from .gitignore
  3. Run npm run build
  4. Push dist folder and .gitignore to your branch
  5. Add branch to package.json by running npm install --save getdkan/data-catalog-components#MY-BRANCH