commit | 364a9d6979fa5e4a05c89b255e10232ef6a91df2 | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Wed Nov 16 23:29:19 2022 +0000 |
committer | Mitchell Kember <mkember@google.com> | Wed Nov 16 23:29:19 2022 +0000 |
tree | 7a7881800558a55c897fbebaabf8d8bf6ce8898c | |
parent | 6596a8096abd519c60901ae0ca09abd67078bd1d [diff] |
Add help entry for Share button Change-Id: I11eb7d93731192ead9e17aeb495bcb3faf6b4356 Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/761603 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_{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.