commit | 3a8376e6c1c5b33c0fae716a55bdf631692eef36 | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Tue Jan 23 21:26:20 2024 +0000 |
committer | Mitchell Kember <mkember@google.com> | Tue Jan 23 21:26:20 2024 +0000 |
tree | 1b18757f0e214dc315b2ae103ca891e2cc7cb4bb | |
parent | fc2e3158bcc3dbe02fb0bb7fd22c9f2350d809b2 [diff] |
Use the coding tables from fidlgen_hlcpp The coding tables have been produced by fidlgen_hlcpp instead of fidlc since I21cc21085d826b61b589b53f64c272dd298bebbe. Bug: b/42115242 Change-Id: I89140d0bb75e4a5ad510213485f3ca76121a1f2c Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/978237 Reviewed-by: Ian McKellar <ianloic@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_{cpp,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.