archive-gh-me/apisix-dashboard
1
0
Fork 0
mirror of https://github.com/apache/apisix-dashboard.git synced 2025-12-08 20:12:51 +00:00
Code Issues Projects Releases Wiki Activity
apisix-dashboard/docs/develop.md
YuanSheng Wang 303cc5612f
docs: update CHANGELOG for v2.2 (#1037) 
* docs: update CHANGELOG for v2.2

Co-authored-by: nic-chen <johz@163.com>
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
2020-12-16 23:02:03 +08:00

1.8 KiB
Raw Blame History

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 v2.2 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
  1. In the root directory, stop development mode.
$ make api-stop
  1. Please refer to the FAQ about the problem of displaying exception in the dashboard after adding custom plugins or modifying plugin's schema.

web

  1. Go to the web directory.
$ cd ./web

  1. Please change the manager-api address in the config/proxy.ts file if needed.

  2. Launch development mode

$ yarn install

$ yarn start
  1. If writing an E2E test, refer to the E2E Writing Guide