Quick start

Edit
Update time: 2024-09-18

This topic helps you quickly download, install, and use SOFADashboard on your computer.

Prepare the environment

sofa-dashboard-backend needs to be run in a Java environment. Make sure that it can be used normally in the following runtime environments:

sofa-dashboard-frontend uses the Ant Design Pro scaffold. For more information about the frontend environment, see Ant Design.

Initialize the database

MySQL version: 5.6+

SOFAArk control uses MySQL for resource data storage. You can find the SofaDashboardDB.sql script under the project directory and run this script to initialize database tables.

ZooKeeper

ZooKeeper 3.4.x and ZooKeeper 3.5.x

Service governance and SOFAArk control of SOFADashboard are dependent on ZooKeeper, therefore you need to start the ZooKeeper service locally. For more information, see ZooKeeper Document.

Run the backend project

> git clone https://github.com/sofastack/sofa-dashboard.git
> cd sofa-dashboard
> mvn clean package -DskipTests
> cd sofa-dashboard-backend/sofa-dashboard-web/target/
> java -jar sofa-dashboard-web-1.0.0-SNAPSHOT.jar

Run the frontend project

sofa-dashboard-front is the frontend code-based project of SOFADashboard. It is developed based on the open-source frontend framework antd of Ant Financial.

> cd sofa-dashboard-front
> npm i
> npm start