Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 987 Bytes

README-reviewers.md

File metadata and controls

35 lines (24 loc) · 987 Bytes

Guide to compile and test run the web extension

Instructions are tested on macOS.

The following code snippet pairs the description (as a bash comment) and the command of each step.

# 0. Install nodejs and ensure that it is in the PATH.

# 1. Install opam - OCaml's package manager.
# src: https://opam.ocaml.org/doc/Install.html
bash -c "sh <(curl -fsSL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)"

# 2. Initialise opam
opam init --bare

# 3. Go to project's folder
cd enforce-browser-fonts

# 4. Set up a local opam switch with OCaml compiler version 4.14.1, and also install the project's opam dependencies.
A switch is roughly equivalent to a virtualenv in Python.
opam switch create . 4.14.1 -y --deps-only

# 5. Bring the current shell env in sync with opam's env
eval $(opam env)

# 6. Install npm dependencies
npm ci

# 7a. Load the extension in dev mode
npm run build && npm run dev:webext

# 7b. Build the extension
npm run build:webext