Google Git
Sign in
fuchsia / fidlbolt / efa925c74f2ea63033360992c81d2e89dccd3535
commitefa925c74f2ea63033360992c81d2e89dccd3535[log] [tgz]
authorMitchell Kember <mkember@google.com>Mon Aug 26 20:51:41 2024 +0000
committerMitchell Kember <mkember@google.com>Mon Aug 26 20:51:41 2024 +0000
tree236a1c86c2606949a68aac6011b6a907320b6eab
parente1c8dfd93e94bc48265a1441f14cf73306522f00 [diff]
Update README

Change-Id: Ia703fef39d87a1fb9ba2b3123a1378468206a618
Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/1105164
Reviewed-by: Ian McKellar <ianloic@google.com>
1 file changed
tree: 236a1c86c2606949a68aac6011b6a907320b6eab
  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_{cpp,hlcpp,rust,go},fidl-{lint,format}}.
  3. Ensure that you have Go and Node.js installed.
  4. Build and run with make && 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. It uses net/http to serve static files and handle POST requests.

Frontend

The frontend is written in Elm and TypeScript. It uses esbuild 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 a new image:

  1. Install Docker. On Debian-based systems, use sudo apt-get install docker-ce.
  2. ./prepare_deployment.sh
  3. sudo docker image build -t fidlbolt .

To run the image in a container locally:

  1. sudo docker container run --publish 8080:8080 --detach --name fb fidlbolt
  2. (When you're done) sudo docker container rm fb

To push the image to the GCP Artifact Registry:

  1. (Only the first time) sudo gcloud auth configure-docker us-central1-docker.pkg.dev
  2. sudo docker tag fidlbolt us-central1-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE
  3. sudo docker push us-central1-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE