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

nova-ui-kit

v1.1.12

Published

Component library for multiple apps related to insect monitoring.

Downloads

366

Readme

Nova UI Kit

Nova UI Kit is a React library with components related to insect monitoring. We use shadcn/ui as a component reference. Components are built using Radix UI and Tailwind CSS. We use Storybook as a visual and interactive documentation of the code version of the UI Kit.

  • Storybook: https://nova-ui-kit.netlify.app/
  • NPM package: https://www.npmjs.com/package/nova-ui-kit

To use the library in your app

1. Add Tailwind and its configuration

Install tailwindcss and its peer dependencies, then generate your tailwind.config.js and postcss.config.js files:

npm install -D tailwindcss postcss autoprefixer

npx tailwindcss init -p

Add this import header to your main css file:

@tailwind base;
@tailwind components;
@tailwind utilities;

2. Install Nova UI Kit

npm install nova-ui-kit

3. Configure styles

Include some base styles in your root component:

import 'nova-ui-kit/dist/style.css'

Update Tailwind config with theme settings:

import { CONSTANTS } from 'nova-ui-kit'

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // ...
    './node_modules/nova-ui-kit/**/*.js',
  ],
  theme: {
    colors: CONSTANTS.COLORS,
    extend: {
      backgroundImage: CONSTANTS.GRADIENTS,
      colors: CONSTANTS.COLOR_THEME,
    },
  },
  plugins: [require("tailwindcss-animate")]
}

The theme can be tweaked as needed for the specific project.

For development

System requirements

  • Node
  • NPM

The .nvmrc file in project root describes the recommended Node version for this project.

Run example app

# Install dependencies
npm install

# Run app in development mode
npm run dev

The example app will now be available in a browser on http://localhost:5173/. Hot reload will be enabled by default.

Run Storybook

# Install dependencies
npm install

# Run Storybook in development mode
npm run storybook

Storybook will now be available in a browser on http://localhost:5174/.

Publish Storybook

Storybook is automatically published when changes are pushed to branch main.

Add a new component

First, checkout the list of available components. Then use the CLI to add a component to the project. This will create a new component in folder /src/components/ui and install any dependencies it might have. Since the component is copied to the project, not installed as a dependency, it can be tweaked as needed.

npx shadcn-ui@latest add [component-name]

Publish to NPM

First, make sure you have a NPM user and have access to update the package nova-ui-kit. Then, make your changes and bump the version in package.json. To publish the changes:

# Login to NPM from terminal
npm login

# Generate package files
npm run pre-publish

# Publish the changes
npm publish

Go to https://www.npmjs.com/package/nova-ui-kit and checkout the changes!