diff options
Diffstat (limited to 'bskyweb/README.md')
-rw-r--r-- | bskyweb/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/bskyweb/README.md b/bskyweb/README.md new file mode 100644 index 000000000..86bc16864 --- /dev/null +++ b/bskyweb/README.md @@ -0,0 +1,39 @@ +## Build / Develop + +### SPA Bundle (monolithic static javascript file) + +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 18 (specifically) + nvm install 18 + nvm use 18 + npm install --global yarn + + # setup tools and deps (in top level of this repo) + yarn install --frozen-lockfile + + # 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 webpack build --config ./web/webpack.config.js -d inline-source-map --color + cp dist/bundle.web.js bskyweb/static/ + +### Golang Daemon + +Install golang. We are generally using v1.19+. + +In this directory (`bskyweb/`): + + # re-build and run daemon + go run ./cmd/bskyweb serve + + # 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. |