# pd-web

**Repository Path**: mirrors_pingcap/pd-web

## Basic Information

- **Project Name**: pd-web
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pd-web (WIP)

PD Web by PingCAP FE.

## The Rules

**Please ensure that each commit is followed the setting of:**

- `.editorconfig`
- `.prettierrc`

### Sass rules

Each `.scss` file is associated with a component, like `Container.scss`.

All components' top class name should keep with `PD-`, for example, `PD-Container` is the top class name of `Container` component.

### Component rules

All main components in the `components` dir should use the form of `index.tsx`, for example:

```sh
Container/
  index.tsx
  Routes.tsx
  Tabs.tsx
Nav/
  index.tsx
```

### Test rules

All test files should be placed in `src/__tests__` dir.

## How to develop

**For development, you must provide a pd client as environment variable.** For example:

```sh
REACT_APP_PD_CLIENT_URL=http://localhost:32845
```

Let's start:

```sh
git clone https://github.com/pingcap-fe/pd-web.git && cd pd-web

# We recommend using yarn
yarn
REACT_APP_PD_CLIENT_URL=http://localhost:32845 BROWSER=none yarn start
```

## Run tests

Make sure the necessary unit tests passed.

```sh
yarn test
```

## License

PD-Web is under the Apache 2.0 license.