Skip to content

lachlanjc/kit

 
 

Repository files navigation

Kit

Tools for developing, documenting, and testing React component libraries

Features

  • Utility components for isolated development
  • Project scaffolding generator
  • Isolated development server
  • Component library viewer

Getting started

Kit contains several different ways to incorporate with your existing setup or generate a new project.

  • Use the CLI to run an isolated development server for example components.
  • Or use the CLI init command to generate a new project.
  • Use the Kit components to customize your existing dev environment, docs, or demos.

CLI

npm install --global @compositor/kit-cli

Development Server

The Kit dev server can be passed either a single React component or a folder of example components.

kit examples

Read more in the dev server docs.

Project Generator

Run kit init and follow the prompts to generate a new project based on several different templates.

Read more in the CLI docs.

Components

Kit components can be added to any existing React setup. Use these utility components to for development, documentation, and demos.

npm install --save @compositor/kit

The Kit component library includes the following:

Read more in the component docs.

Related

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Made by Compositor | MIT License

About

Tools for developing, documenting, and testing React component libraries

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.0%
  • HTML 1.6%
  • CSS 0.4%