commit | 42fecee0922da5dd1222a668ac9f436ae73d890e | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Wed Sep 22 06:08:32 2021 +0000 |
committer | Mitchell Kember <mkember@google.com> | Wed Sep 22 06:08:32 2021 +0000 |
tree | a23eea996b90deff2e9965d6fd2c89e0a17e99c0 | |
parent | 749b6dd2206df5282ec106f6a477db87f95f692c [diff] |
Use out/fidlbolt build directory in prepare_deployment.sh This CL makes prepare_deployment.sh run 'fx set core.x64 --release' in a separate Fuchsia build directory, out/fidlbolt. This makes it easier to deploy without interfering with other work, and eliminates the chance of accidentally deploying the wrong build (e.g. a debug build). Change-Id: Ifa1474db8d954aafb22f5a59737d2a13f7afec88 Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/584263 Reviewed-by: Yifei Teng <yifeit@google.com>
fidlbolt is web app for exploring FIDL code and bytes, inspired by Matt Godbolt's Compiler Explorer.
To run a local fidlbolt server:
fx build host_x64/{fidlc,fidlgen_{llcpp,hlcpp,rust,go,dart}} zircon/tools
.make run
.http://localhost:8080
.If you don't want changes in the Fuchsia tree (e.g. rebuilding fidlc or changing FIDL libraries) to affect the running fidlbolt, run ./prepare_deployment.sh
and use make run DEPLOYMENT=1
instead.
The backend is written in Go 1.13. It uses net/http to serve static files and handle POST requests.
The frontend is written in Elm and TypeScript. It uses webpack for bundling.
To set up the frontend:
sudo apt-get install npm
.cd frontend && npm ci
(using ci
instead of install
ensures a repeatable build).Then, use one of the commands listed in npm run
:
npm run dev
: build in development modenpm run watch
: rebuild in development mode on every file changenpm run tc
: typecheck TypeScript filesnpm run lint
: run eslint on TypeScript filesnpm run fix
: format and fix lint issues in TypeScript and Elm filesnpm run build
: build in production modeThe build commands read files in frontend/src/
and generate output in frontend/dist/
.
If you are developing on Linux, ./watch.sh
provides an easy workflow. It automatically watches code in the frontend (using npm run watch
) and backend (using inotifywait), rebuilding and restarting the server as necessary. It does not perform hot/live reloading: you still need to refresh the browser manually to see changes.
Before making a CL, always run make format
.
The project uses Docker for containerized deployment.
To build and run a new image locally:
sudo apt-get install docker-ce
../prepare_deployment.sh
docker image build -t fidlbolt .
docker container run --publish 8080:8080 --detach --name fb fidlbolt
You might need to use sudo
with the Docker commands.