From 3fd66703564a8c8390aea827c547db0b5d139a3b Mon Sep 17 00:00:00 2001 From: Elliot Braem <16282460+elliotBraem@users.noreply.github.com> Date: Wed, 10 Apr 2024 14:47:17 -0400 Subject: [PATCH] default testnet --- README.md | 19 +++++++++++++++---- package.json | 3 +-- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ea90f80..8bf51a8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -# Documentation +# bos-workspace-docs -This example app holds the documentation for bos-workspace. Feel free to clone [this template]() to use it in your own project. +## Getting started -TODO: -- [] this could be a git submodule, to a template docs repository +1. Install packages + +```cmd +yarn install +``` + +2. Start dev environment + +```cmd +yarn run dev +``` + +This will start a gateway at [127.0.0.1:8080](http://127.0.0.1:8080) which will render your local widgets. The entry point for this app is [docs.bos-workspace.testnet/widget/index](http://127.0.0.1:8080/docs.bos-workspace.testnet/widget/index) diff --git a/package.json b/package.json index b4752ba..a5370c9 100644 --- a/package.json +++ b/package.json @@ -8,8 +8,7 @@ "fmt": "prettier --write '**/*.{js,jsx,ts,tsx,json}'", "fmt:check": "prettier --check '**/*.{js,jsx,ts,tsx,json}'", "bw": "bos-workspace", - "dev": "bw dev", - "dev:testnet": "bw dev --network testnet", + "dev": "bw dev --network testnet", "build": "bw ws build", "build:testnet": "bw ws build -n testnet" },