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.

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