The Dashboard contains both
web parts, so you need to start the development environment separately.
Before development, refer to this guide to install dependencies.
#Clone the project
$ git clone -b release/3.0 https://github.com/apache/apisix-dashboard.git
$ cd apisix-dashboard
Please change the configuration in
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
- Go to the
$ cd ./web
- Please change the
manager-apiaddress in the
web/.envfile. If you follow this guidelines, the address may need to be set as below.
All commands here are for Linux environment, other systems please use the corresponding commands for your platform. You are also welcome to contribute your own methods.
echo "SERVE_URL_DEV=http://localhost:9000" > web/.env
If you don't want to create the file, you can also export the variable.
- Launch development mode
$ yarn install
$ yarn start
If there is an error about gyp during yarn install, please ignore it and go ahead!
- If writing an front end E2E test, please refer to the Front End E2E Writing Guide