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

@ui-library-lab/ui-library

v0.0.1

Published

- [UiLibrary](#uiLibrary-storybook) - [Overview](#overview) - [Technologies](#technologies) - [Getting Started Storybook](#getting-started-storybook) - [Development](#development) - [Production](#production) - [Getting Started with library](#get

Downloads

12

Readme

Ui Library Storybook

Table of Contents

Overview

Ui Library storybook is a project based on the Ui Library design that has been implemented as a library component.

Technologies

Folder Structuring

in this project we follow the folder structuring based on component categories

note: for more information about component categories please visit full-documentation

.
└── src/
    ├── components/
    |   ├── index.ts
    │   ├── Input/
    │   │   └── Button/
    │   │       ├── story/
    │   │       │   ├── button.stories.tsx
    │   │       │   └── template.tsx
    │   │       ├── prototype/
    │   │       │   └── buttonProto.ts
    │   │       ├── button.tsx
    │   │       └── style.ts
    │   └── Surface/
    │       └── app-bar/
    │           ├── story/
    │           │   ├── AppBar.stories.tsx
    │           │   └── template
    │           ├── prototype/
    │           │   └── appBarProto.ts
    │           ├── AppBar.tsx
    │           └── AppBar.module.css
    └── utils/
        ├── assets/
        │   └── icons
        ├── configs
        ├── helpers
        └── static-data

Getting Started Storybook

you can start storybook of the library project in two ways: running simple, running with Docker

Development

 yarn dev | npm run dev

Production

Build and Run with Docker

  docker-compose -f docker-compose.yml up [-d] [--build] [--foce-recreate]

Getting Started library

you can see the npm address of the component from this link

install the library

to install the library in your project you can use following commands:

npm:

npm i @dvh-uiLibrary/uiLibrary-storybook

yarn:

yarn add @dvh-uiLibrary/uiLibrary-storybook

Usage

for using this library inside your projects you can import the components from the root directory of the project example:

import { Button } from "@dvh-uiLibrary/uiLibrary-storybook";

function ExampleButton() {
  return (
    <div>
      <Button label="Submit" backgroundColor="blue" />
    </div>
  );
}

Naming Convetions:

  1. all folders follow the kebab-case convention for naming.
  2. all files follow the camelCase convention for naming.
  3. all variables and functions follow the camelCase convention for naming.

Git Conventions:

for working with the git we should follow the workflow based on this convention, at firts make your branch based on the latest version of the develop branch with following naming conenvtions for the branch name:

[type of task]/[branch title with kebab case letters]

for type of task we have:

  • feature: for add new feature task
  • refactor: if your task is to refactoring some of the codes
  • fix: if your task is debugging some features

for example

feature/add-button-component

after finishing your task make pull request to the develop branch

Commits Conventions:

for the commits we should follow the convention that it covers id of your task related to this commit in the tasks board, times that you worked on this commit, and phase of this commit. pattern:

[`[type of your task]`][ `'closes'` | `'refs'` ]#[your task id]@[times that you've spent on this commit]<br/>
[your message description]

for type of tasks we have:

  • [DOC]: for adding feature or refactoring in the documentations
  • [FEAT]: for adding new feature to the project
  • [REF]: refactor some of codes
  • [TEST]: for adding tests
  • [DEB]: for debugging

for 'closes' and 'refs': if you have done you task and you want to move it into done sections, use 'closes', and if there is still works to be done use 'refs' for the task id: you should enter id of your taks in the tasks board that is related to this commit for the time: you should enter times that you have spent on this task based on hour(h), minutes(m)

Example:

  • step one: use git commit without -m

    git commit
  • step two: add your commit description like the pattern for this task of documentation we have added a commit like this

    [DOC]:closes#124@20m
    add commit conventions to the readme file
  • step three: save the file and exit in this view we can find what is the topic that we are working on, phase of this commit, related task in the task board and how many time resources we have spent on it