DEVELOPER_GUIDE.md

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
  • Start documentation server
• Maintenance and contributing

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

• Component design
• Component development
  • Creating components manually
  • Creating components with Yeoman
• Creating icons
• Theming
• Testing
  • Accessibility Testing
  • Validating with OpenSearch Dashboards
• Documentation
• Releasing versions