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

awesome-dashboard

v0.0.24

Published

<h1 align="center"> Awesome Dashboard </h1>

Downloads

10

Readme

It's built for using on Mobagel 8ndpoint's project. We wrapped ant design's component or built some component for common scenery case. To make our develop effieciency.

Installation

  • Install plugin
yarn add awesome-dashboard
// or with npm
npm install awesome-dashboard

Usage

For example to implement NotificationBar component.

import { NotificationBar } from 'awesome-dashboard';

...
        <NotificationBar
          styles={customStyle}
          message={formatMessage({
            id: 'common.message.upgrade',
            defaultMessage: `Your trial plan has expired. Please upgrade to an advanced plan to continue using 8ndpoint's AI services`,
          })}
          cancelButtonLabel={formatMessage({
            id: 'common.action.learn',
            defaultMessage: 'Learn more',
          })}
          cancelButtonProp={{
            href: 'https://www.8ndpoint.com/restock#pricing-plan',
            target: '_blank',
          }}
          confirmButtonLabel={formatMessage({
            id: 'common.action.upgrade',
            defaultMessage: 'Upgrade',
          })}
          confirmButtonProp={{ href: 'https://www.8ndpoint.com/contact', target: '_blank' }}
          onCloseBanner={handleCloseNotify}
        />
...

You can open Storybook to see more components you can use.

How to Develop

We advice you develop component on storybook. Because it can make our component's status individual. And you can demo component on storybook.

Start local environment

yarn

// build storybook yarn build-storybook

// start storybook yarn storybook


### Install lang
If you need to build component working with i18n.

- Add .env file fill airtable key

AirTable parameters, plz check these in airtable doc

AIRTABLE_KEY= AIRTABLE_I18N_BASE_COMMON= AIRTABLE_I18N_TABLE_COMMON= AIRTABLE_I18N_VIEW_COMMON=


- Install lang

// download lang.json yarn i18n:fetch


### Write unit test and storybook sample
Don't forget to update component sample on storybook. It can make next developer who can easily realize how to use component.

And update unit test to check component render or interactive case.

### Deploy step
We have already integrated `github action`. You just need create version tag on `github`. And it will automatically build and deploy on npm.

You can see `.github/workflow/publish.yml`. It's CI/CD setting.


- if you still need to deploy from your local

yarn build

// Update package.json version npm version [major | minor | patch] // major 0.0.0 -> 1.0.0 // minor 0.0.0 -> 0.1.0 // patch 0.0.0 -> 0.0.1

npm publish


### Storybook
You can see component's props on storybook or you can open component's type file to see what prop you can pass.

Link: [Storybook](https://mobagel.github.io/awesome-dashboard/ "Storybook")