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

nvm install

Start documentation server

You can run the documentation locally at http://localhost:8030/ by running the following. Yarn may give error about failing to install Puppeteer, but you will still be able to do everything except run a11y tests.

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
• Documentation
• Releasing versions