commit | 206cc28cdfbd8007cd42fb8aefcb63dbad133266 | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Mon Apr 20 09:05:07 2020 -0700 |
committer | Mitchell Kember <mkember@google.com> | Mon Apr 20 09:05:07 2020 -0700 |
tree | 2e449d1e67e65379dd82634a60a6a0168acc463e | |
parent | a28a3acebaabb15365671a77f0834ce088a2f1eb [diff] |
Use ZIRCON_TOOLS_DIR in prepare_deployment.sh I forgot to change this in I5b200e9983a0142841faee100e58f8553eaab5eb. I had at first been using `fx ninja` for a more targeted build, but went back to `fx build zircon/tools` because it didn't seem to pick up all changes. With that, it is simpler to use the ZIRCON_TOOLS_DIR directory. Change-Id: I71170353a075896d551badf7709fa6695d8d816a
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 nodejs
.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.