Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.65 KB

running-eui-locally.md

File metadata and controls

50 lines (31 loc) · 1.65 KB
Raw

Setting up and running EUI locally

The below instructions run EUI's documentation site locally, with any changes made in src/ reflected. On local, EUI's favicon will be gray instead of colored.

Set up

Node

We depend upon the version of node defined in .nvmrc.

You will probably want to install a node version manager. nvm is recommended.

To install and use the correct node version with nvm:

nvm install

Dependencies

EUI uses yarn for dependency management. We use npm for release purposes only.

EUI only uses yarn@v1 (classic), and not yarn v2 or above. Ensure you are on the correct version via yarn -v before installing all dependencies:

yarn

Puppeteer issues

If you're on an Apple arm64 machine and receive an error on yarn about Puppeteer/the chromium binary not being available, you have two options:

  1. If you don't need to run Puppeteer tests locally:
    • Paste PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true into your terminal as an environment variable
  2. If you do need need to run Puppeteer locally:

Running

You can run the documentation locally at http://localhost:8030/ with the following command:

yarn start

If another process is already listening on port 8030, the next free port will be used. Alternatively, you can specify a port:

yarn start --port 9000