| 1 | # Betty Blocks Component CLI
|
| 2 |
|
| 3 | ## Installation
|
| 4 |
|
| 5 | To install the CLI you will need [a recent version of Node.js](https://nodejs.org/en/).
|
| 6 |
|
| 7 | ```bash
|
| 8 | $ npm install -g @betty-blocks/cli@23
|
| 9 | ```
|
| 10 |
|
| 11 | ## Introduction
|
| 12 |
|
| 13 | Welcome to the GitHub repository for the Betty Blocks Component System command-line interface (CLI). This CLI lets you develop Component Sets for Betty Blocks, a no-code platform for business users. Not using Betty Blocks yet? Find out more at [https://www.bettyblocks.com](https://www.bettyblocks.com).
|
| 14 |
|
| 15 | This project is the first part of the Betty Blocks Component System available as open-source software. This package was initially used internally by Betty Blocks to build Components for the [Page Builder](https://docs.bettyblocks.com/en/articles/998115-what-is-the-page-builder).
|
| 16 |
|
| 17 | ## Contents
|
| 18 |
|
| 19 | This is the recommended order of reading up on Component System concepts:
|
| 20 |
|
| 21 | * [Get up and running with the Betty Blocks Component System CLI](https://github.com/bettyblocks/cli/wiki/Usage).
|
| 22 | * Before building your own Component Set, familiarize yourself with the [Core Concepts](https://github.com/bettyblocks/cli/wiki/Core-Concepts).
|
| 23 | * Read how several concepts work together to form the [Component System](https://github.com/bettyblocks/cli/wiki/Component-System).
|
| 24 | * Understand how [Prefabs](https://github.com/bettyblocks/cli/wiki/Prefabs) form the main building Blocks of your Component Set.
|
| 25 | * Learn how you can build the [Components](https://github.com/bettyblocks/cli/wiki/Components) that make up the Prefabs.
|
| 26 | * Allow the End User to customize your components with [Component Options](https://github.com/bettyblocks/cli/wiki/Component-Options).
|
| 27 | * Use the API's described in [Component Helpers](https://github.com/bettyblocks/cli/wiki/Component-Helpers) to add functionality to your Components.
|
| 28 | * For those familiar with TypeScript, read more about [the types of the Component System](https://github.com/bettyblocks/cli/wiki/Types).
|