commit | 03325c23237fc854ea1b33de04ce259db7def343 | [log] [tgz] |
---|---|---|
author | Zachary Stewart <zstewart@google.com> | Thu May 12 16:03:40 2022 +0000 |
committer | Zachary Stewart <zstewart@google.com> | Thu May 12 16:03:40 2022 +0000 |
tree | e7907fddf6efb07d1c4adff5dcd4b272125c9ccb | |
parent | 03f45abdfc48ece0d12fa505f10f754b7bb90280 [diff] |
Show driver-transport natural types. Update the LLCPP file selection drop-downs to also show driver/natrual_messaging.h and driver/natrual_messaging.cc Change-Id: I3f652ed2266a1516533ae99fa21e524bf7f4f100 Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/678311 Reviewed-by: Mitchell Kember <mkember@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. 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.