Tools for developing, documenting, and testing React component libraries
- Utility components for isolated development
- Project scaffolding generator
- Isolated development server
- Component library viewer
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
initcommand to generate a new project. - Use the Kit components to customize your existing dev environment, docs, or demos.
npm install --global @compositor/kit-cliThe Kit dev server can be passed either a single React component or a folder of example components.
kit examplesRead more in the dev server docs.
Run kit init and follow the prompts to generate a new project based on several different templates.
Read more in the CLI docs.
Kit components can be added to any existing React setup. Use these utility components to for development, documentation, and demos.
npm install --save @compositor/kitThe Kit component library includes the following:
- Library
- XRay
- Debug
- Responsive
- Frame
- Cartesian
- Matrix
- LiveEditor
- PropsForm
- Markdown
- State
- Diff
- And more...
Read more in the component docs.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
