Google Git
Sign in
fuchsia/fidlbolt/5679cab8102c19a0171e8ab90dc84719d5987db4
commit
5679cab8102c19a0171e8ab90dc84719d5987db4
[log]
author
Yifei Teng <yifeit@google.com>
Mon Mar 23 16:17:55 2020 -0700
committer
Yifei Teng <yifeit@google.com>
Mon Mar 23 16:17:55 2020 -0700
tree
d74e354b2676df32f76be0afe9d8ea266828e6ca
parent
c2d9db411b015bd9a48c13af466d11bc4b14b235 [diff]
Run `npm ci` instead of `npm install` when deploying

To ensure reproducible builds.
1 file changed
tree: d74e354b2676df32f76be0afe9d8ea266828e6ca
  1. backend/
  2. frontend/
  3. .dockerignore
  4. .gitignore
  5. AUTHORS
  6. CHANGELOG.md
  7. CONTRIBUTING.md
  8. copy_fuchsia_files.sh
  9. Dockerfile
  10. LICENSE
  11. Makefile
  12. PATENTS
  13. README.md
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, use make run COPY=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. On Debian-based systems, use sudo apt-get install nodejs.
  2. cd frontend && npm install

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/.

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. Run ./copy_fuchsia_files.sh to get the latest FIDL files and binaries from your Fuchsia repository.
  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.