Google Git
Sign in
fuchsia / fidlbolt / 4a913a5b2cffefced0a5fef984bd4d162d13ed0d
commit4a913a5b2cffefced0a5fef984bd4d162d13ed0d[log] [tgz]
authorMitchell Kember <mkember@google.com>Thu Sep 09 01:00:10 2021 +0000
committerMitchell Kember <mkember@google.com>Thu Sep 09 01:00:10 2021 +0000
tree51a85f71350edac86fe71b372079eb9645f9f9d6
parent7853f1684d19c5fe15f30823dcde8a010e97bd6e [diff]
Clean up after syntax migration

This CL reverts the auto-convert feature that was temporarily added in
I4e4f33f177860be8db7a139b9d81192e0bca7d1e for the new FIDL syntax, since
this no longer works as of the cleanup in fxrev.dev/574026. It leaves
the "news" abstraction since we can reuse this in the future.

Change-Id: I27b7c54363a3864693cbdb8143bc4588b25553f3
Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/579181
Reviewed-by: Yifei Teng <yifeit@google.com>
6 files changed
tree: 51a85f71350edac86fe71b372079eb9645f9f9d6
  1. backend/
  2. frontend/
  3. .gcloudignore ⇨ .dockerignore
  4. .dockerignore
  5. .gitignore
  6. AUTHORS
  7. CHANGELOG.md
  8. CONTRIBUTING.md
  9. Dockerfile
  10. LICENSE
  11. Makefile
  12. PATENTS
  13. prepare_deployment.sh
  14. README.md
  15. watch.sh
README.md

fidlbolt

fidlbolt is web app for exploring FIDL code and bytes, inspired by Matt Godbolt's Compiler Explorer.

Get started

To run a local fidlbolt server:

  1. Follow the Fuchsia: Get Started guide.
  2. Build FIDL tools: fx build host_x64/{fidlc,fidlgen_{llcpp,hlcpp,rust,go,dart}} zircon/tools.
  3. Ensure that you have Go and Node.js installed.
  4. Build and run with make run.
  5. View the app at 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.

Contributing

Backend

The backend is written in Go 1.13. It uses net/http to serve static files and handle POST requests.

Frontend

The frontend is written in Elm and TypeScript. It uses webpack for bundling.

To set up the frontend:

  1. Install Node.js and npm. On Debian-based systems, use sudo apt-get install npm.
  2. 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 mode
  • npm run watch: rebuild in development mode on every file change
  • npm run tc: typecheck TypeScript files
  • npm run lint: run eslint on TypeScript files
  • npm run fix: format and fix lint issues in TypeScript and Elm files
  • npm run build: build in production mode

The build commands read files in frontend/src/ and generate output in frontend/dist/.

Workflow

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.

Style

Before making a CL, always run make format.

Deployment

The project uses Docker for containerized deployment.

To build and run a new image locally:

  1. Install Docker. On Debian-based systems, use sudo apt-get install docker-ce.
  2. ./prepare_deployment.sh
  3. docker image build -t fidlbolt .
  4. docker container run --publish 8080:8080 --detach --name fb fidlbolt

You might need to use sudo with the Docker commands.