Code Monkey home page Code Monkey logo

ncn-utils's Introduction

Docs

https://ncn-ends.github.io/ncn-utils/

Info

  • Using Storybook to develop components in isolation
  • Using jest for unit tests
  • Using react-hooks-testing-library to test custom hooks
  • Using swc for the compiler because it's faster than babel and the default jest compiler
  • Using Typedoc to generate documentation, but looking for better options
  • Using husky for git hooks

Goals

  • Absolutely minimal 3rd party dependencies
  • Maximum compatibility
  • Maximum reuseability

Future Plans

Components

  • Tooltip
  • Timeline
  • Toast

Hooks

  • useDetectClickOutside
    • Detects if a click action was taken outside of a component
      • useful for modals that should be closed when clicked outside

Getting Started: Development

  1. Install dependencies at project root
npm install
  1. Set up husky hooks
npm run prepare
  1. Initialize MSW
npm run msw:build
  1. Start Storybook server
npm run storybook:run
  1. Run tests
npm run test

ncn-utils's People

Contributors

ncn-ends avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.