Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bettyblocks/cli
Command-line interface for the Betty Blocks Component System
https://github.com/bettyblocks/cli
betty-blocks no-code
Last synced: 3 days ago
JSON representation
Command-line interface for the Betty Blocks Component System
- Host: GitHub
- URL: https://github.com/bettyblocks/cli
- Owner: bettyblocks
- License: apache-2.0
- Created: 2019-09-19T07:47:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T11:24:29.000Z (3 months ago)
- Last Synced: 2024-09-02T08:43:05.245Z (2 months ago)
- Topics: betty-blocks, no-code
- Language: TypeScript
- Size: 4.07 MB
- Stars: 28
- Watchers: 17
- Forks: 16
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Betty Blocks Component CLI
## Prerequisites
As of version `25.29.0`, you will need to install the [requirements for IsolatedVM](https://www.npmjs.com/package/isolated-vm#requirements) which basically include:
- make
- g++
- python
## Installation
To install the CLI you will need [a recent version of Node.js](https://nodejs.org/en/).
```bash
$ npm install -g @betty-blocks/cli
```
To install the CLI without optional dependencies (isolated-vm)
```bash
$ npm install -g @betty-blocks/cli --no-optional
```
## Update
To update the CLI
```bash
$ npm update -g @betty-blocks/cli
```
To update the CLI without optional dependencies (isolated-vm)
```bash
$ npm update -g @betty-blocks/cli --no-optional
```
## Introduction
Welcome to the GitHub repository for the Betty Blocks command-line interface (CLI).
This CLI lets you develop 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).
## Contents
This is the recommended order of reading up on Component System concepts:
- [Get up and running with the Betty Blocks Component System CLI](https://github.com/bettyblocks/cli/wiki/Components:Usage).
- Before building your own Component Set, familiarize yourself with the [Core Concepts](https://github.com/bettyblocks/cli/wiki/Components:Core-Concepts).
- Read how several concepts work together to form the [Component System](https://github.com/bettyblocks/cli/wiki/Components:Component-System).
- Understand how [Prefabs](https://github.com/bettyblocks/cli/wiki/Components:Prefabs) form the main building Blocks of your Component Set.
- Learn how you can build the [Components](https://github.com/bettyblocks/cli/wiki/Components:Components) that make up the Prefabs.
- Allow the End User to customize your components with [Component Options](https://github.com/bettyblocks/cli/wiki/Components:Component-Options).
- Use the API's described in [Component Helpers](https://github.com/bettyblocks/cli/wiki/Components:Component-Helpers) to add functionality to your Components.
- For those familiar with TypeScript, read more about [the types of the Component System](https://github.com/bettyblocks/cli/wiki/Components:Types).