Development Guide
The Dashboard contains both manager-api
and web
parts, so you need to start the development environment separately.
#
PrerequisitesBefore development, refer to this guide to install dependencies.
#
Clone the project$ git clone -b release/2.8 https://github.com/apache/apisix-dashboard.git
#
Start developing$ cd apisix-dashboard
#
manager-apiPlease change the configuration in
api/conf/conf.yaml
.In the root directory, launch development mode.
$ make api-run
- In the root directory, stop development mode.
$ make api-stop
Please refer to the FAQ about the problem of displaying exception in the dashboard after adding custom plugins or modifying plugin's schema.
If writing an back end E2E test, please refer to the Back End E2E Writing Guide
#
web- Go to the
web
directory.
$ cd ./web
Please change the
manager-api
address in theconfig/defaultSettings.ts
file if needed.Launch development mode
$ yarn install
$ yarn start
- If writing an front end E2E test, please refer to the Front End E2E Writing Guide