In this article you'll learn how to develop, test, and deploy BOS components using CLI tools. You can use this workflow to tap into the colaboration, pull-request, and other GitHub benefits while still deploying components to the BOS.
BOS Component 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.
(Optional) Download and install
bosCLI if you have component code on the BOS already that you want to use or if you want to manage component deploys locally instead of the GitHub actions CI/CD.
To get component code saved on the BOS, use
bosto download the source code. Otherwise, create a
Create a component within that src folder like
It's common practice to use
.delimited component names for namespacing. You can handle this with folders for better files organization.
Download and install BOS Component Loader (
bos-loader <youraccount.near> --path src(or run from
Open https://near.org/flags, and set the loader URL to
https://near.org/<youraccount.near>/widget/<component name>(case sensitive)info
If you're testing on
testnet, use your testnet account and open https://test.near.org instead.
bos-loader <youraccount.testnet> --path srclocally, set loader URL in https://test.near.org/flags and open
https://test.near.org/<youraccount.testnet>/widget/<component name>to view your component locally.tip
You can work on multiple components at once by embedding them in a wrapper component.
Make changes to the component's code.info
You must refresh the browser's web page to see the changes.
When you're done, use the X on the banner to stop loading locally.
At this point, your new component is ready to be deployed. To deploy, you can use either of the following two paths:
bosCLI to deploy from command line:
You should now be able to see your component in discovery. Happy Hacking!