caldera-components v0.1.0

Caldera Components

🌋 Documentation

What Is This?

UI components for Caldera Forms admin, Caldera Forms 2.0 front-end

Why Is This?

See goals

How To Use This

Install

npm i -D @caldera-labs/components

Basic Usage Examples

How To Develop This

Development Requirements

• npm
• Yarn
• Git

Testing

See testing documentation

Scripts

Develop

• yarn start
  • Runs linter and compiles for production
  • Starts test app server

Tests

• yarn test
  • Run test watcher
• npm test:once
  • Run tests once

Lint Code

• yarn lint
  • Run linter and fixer watch
• yarn lint:fix
  • Lint and fix code once
• yarn lint:once
  • Lint code once

Generate Documentation

• npm run documentation
  • Generates documentation from inline docs
  • Generates documentation from markdown files in /manual

Release To npm

Must be logged in as project maintainer via npm cli

• yarn release