Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 1.97 KB

DEVELOPER_GUIDE.md

File metadata and controls

66 lines (47 loc) · 1.97 KB

OUI Developer Guide

This guide applies to all development within the OpenSearch Dashboards project and is recommended for the development of all OpenSearch Dashboards plugins.

Running locally

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 v with nvm:

v - version mentioned in .nvmrc.

nvm install

And then also set the node version to use in your terminal

nvm use

Confirm the version of node by running:

yarn node --version

Start documentation server

You can run the documentation locally at http://localhost:8030/ by running the following.

yarn
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

Maintenance and contributing

CONTRIBUTING.md