diff --git a/bskyweb/README.md b/bskyweb/README.md index 6da8e1d06a..b682929975 100644 --- a/bskyweb/README.md +++ b/bskyweb/README.md @@ -6,21 +6,26 @@ To build the SPA bundle (`bundle.web.js`), first get a JavaScript development environment set up. Either follow the top-level README, or something quick like: - # install nodejs - nvm install - nvm use - npm install --global yarn +```bash +# install nodejs +nvm install +nvm use +npm install --global yarn - # setup tools and deps (in top level of this repo) - yarn install --frozen-lockfile +# setup tools and deps (in top level of this repo) +yarn install --frozen-lockfile - # run yarn web dev server, if you wanted - yarn web +# run yarn web dev server, if you wanted +yarn web +``` Then build and copy over the big 'ol `bundle.web.js` file: - # in the top level of this repo - yarn build-web + +```bash +# in the top level of this repo +yarn build-web +``` ### Golang Daemon @@ -28,11 +33,13 @@ Install golang. We generally develop against the current stable release of the l In this directory (`bskyweb/`): - # re-build and run daemon - go run ./cmd/bskyweb serve +```bash +# re-build and run daemon +go run ./cmd/bskyweb serve - # build and output a binary - go build -o bskyweb ./cmd/bskyweb/ +# build and output a binary +go build -o bskyweb ./cmd/bskyweb/ +``` The easiest way to configure the daemon is to copy `example.env` to `.env` and fill in auth values there.