github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/dm/ui/README.md (about)

     1  # DM Web UI
     2  
     3  Web UI for TiDB Data Migration Platform, built with TypeScript and React.
     4  
     5  ## Development
     6  
     7  To start to develop it you will need Nodejs environment ready and yarn installed as package manager, following scripts will help you to get started:
     8  
     9  ```bash
    10   # install dependencies
    11  yarn install
    12  
    13  # start the development server
    14  yarn start
    15  
    16  # build and output static files to `dist` directory
    17  yarn build
    18  ```
    19  
    20  See `package.json` for more scripts.
    21  
    22  By default, it talks to local DM Server through `http://localhost:8261/api/v1/...`, so you will need to have it running in your machine first.
    23  
    24  Make sure you have Golang installed since we'll need to build the server binaries from source, at the root of this project, run `make dm-worker` and `make dm-master` to get them.
    25  
    26  Create conf file for them, there are plenty of examples in `dm/tests/openapi/conf` directory. The `openapi` option is still experimental and is off by default so make sure you set it to true.
    27  
    28  Then run master and worker with configs you just created respectively. For example:
    29  
    30  ```bash
    31  ./bin/dm-master -config path/to/conf.yaml
    32  ./bin/dm-worker -config path/to/conf.yaml
    33  ```
    34  
    35  Now you can start the front-end development server with `yarn start`!.