develop.md

title
Development Guide

The Dashboard contains both manager-api and web parts, so you need to start the development environment separately.

Prerequisites

Before development, refer to this guide to install dependencies.

Clone the project

$ git clone -b release/2.10.1 https://github.com/apache/apisix-dashboard.git

Start developing

$ cd apisix-dashboard

manager-api

1. Please change the configuration in api/conf/conf.yaml.

2. In the root directory, launch development mode.

$ make api-run

3. In the root directory, stop development mode.

$ make api-stop

4. Please refer to the FAQ about the problem of displaying exception in the dashboard after adding custom plugins or modifying plugin's schema.

5. If writing an back end E2E test, please refer to the Back End E2E Writing Guide

web

1. Go to the web directory.

$ cd ./web

2. Please change the manager-api address in the config/defaultSettings.ts file if needed.

3. Launch development mode

$ yarn install

$ yarn start

4. If writing an front end E2E test, please refer to the Front End E2E Writing Guide