Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 4.47 KB

resources.md

File metadata and controls

87 lines (63 loc) · 4.47 KB

Resources

Key documentation

Must know info for builders

Things to read:

Things to watch:

Existing Components

Fork, customize, embed, get inspired

Tools

Get your picks and shovels here

  • bos-loader
    • Serves a local directory of component files as a JSON payload properly formatted to be plugged into a BOS redirectMap. When paired with a viewer configured to call out to this loader, it enables local component development—especially when working on multiple components in parallel.
  • bos-cli-rs
    • Component syncing and CI/CD. Ability to download and deploy widgets, as well as make calls to the social contract.
  • bos-component-ts-starter
    • Transpiles TSX to JSX using sucrase. Also, automatically returns the export default function as BOS component, so you don't need to have a free-standing return <MyComponent props={props} /> statement at the end of your file.
  • bos-workspace
    • like bos-loader, but more feature-rich. Starts a local gateway, supports Typescript (instead of ts-starter), has hot reload, local widget development in favorite text editor.

Getting started with bos-workspace

Install create-bos-app

pnpm add -g @archetype-org/create-bos-app

After installing, run the CLI to start your app, switch to the app directory, and start up the dev environment

create-bos-app
cd app
yarn dev

Note: bos-workspace has a new version coming out. Feedback wanted on bos-workspace v1. This will combine create-bos-app and bos-workspace.

Current Build DAO

Works in progress - builders wanted

Writings

Motivation, inspiration, reflection, innovation