abordin / browserhtml

Experimental Servo browser built in HTML

Browser.html

Browser.html is a research project aimed at building an experimental Servo browser in HTML. This project has 2 major pieces:

• Graphene: a runtime for building native apps in HTML. It's currently in development and part of Servo.
• Browser.html: an experimental browser UI for desktop.

This repository is for Browser.html (the front-end). Active development of Graphene happens in the Servo repository. Questions? Check out the FAQ.

Contributing

We welcome contributions from anyone. See CONTRIBUTING.md for help getting started.

Building and Running

The Browser.html UI is bundled with Servo. To run it, you'll need to build Servo.

First, install Servo's prerequisites. Then, clone and build Servo:

git clone https://github.com/servo/servo
cd servo
./mach build -r

Finally, run Servo with the --browserhtml flag.

./mach run -r --browserhtml

Developing the Front-end

If you're working on the Browser.html front-end, you'll want to run the web app locally.

Prerequisites: You'll need Node and NPM. Next, clone Browser.html and install its Node dependencies.

git clone https://github.com/browserhtml/browserhtml.git
cd browserhtml
npm install --no-optional

Then, start the front-end local server:

npm run build-server

Finally, in a new command line interface application (ex: Terminal), start Servo with the Browser.html flags turned on in either debug (-d) or release (-r) mode:

./mach run -r -- -b -w --pref dom.mozbrowser.enabled --pref dom.forcetouch.enabled --pref shell.builtin-key-shortcuts.enabled=false http://localhost:6060

Running in Gecko

Browser.html can also be run on top of a Gecko-based version of Graphene. We sometimes use this variant to test and debug features that haven't yet landed in Servo. Build instructions for Gecko-flavored Graphene can be found on the wiki.

Using WebIDE

The easiest way to use developer tools with Browser.html is to select the "Remote Runtime" option in WebIDE while using the Gecko Graphene runtime.

By default you should be able to connect to the running browser at: localhost:6000.

Integration Tests

Run integration tests with ./test/runall.sh. You need to have a Graphene Gecko binary symlinked in the root of the repository.

ln -s ../gecko/obj-graphene/dist/Graphene.app graphene