Skip to content

Commit

Permalink
[Fix][Engine UI] update the doc. How to use it
Browse files Browse the repository at this point in the history
  • Loading branch information
QiaoJ-Chen committed Sep 22, 2024
1 parent 93bd2ce commit 2a34003
Showing 1 changed file with 2 additions and 32 deletions.
34 changes: 2 additions & 32 deletions seatunnel-engine/seatunnel-engine-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,5 @@
# seatunnel-engine-ui

This template should help get you started developing with Vue 3 in Vite.

## Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).

## Type Support for `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project Setup

```sh
Expand All @@ -32,29 +18,13 @@ pnpm dev
pnpm build
```

### Run Unit Tests with [Vitest](https://vitest.dev/)
### Run Unit Tests with [Vitest]

```sh
pnpm test:unit
```

### Run End-to-End Tests with [Cypress](https://www.cypress.io/)

```sh
pnpm test:e2e:dev
```

This runs the end-to-end tests against the Vite development server.
It is much faster than the production build.

But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):

```sh
pnpm build
pnpm test:e2e
```

### Lint with [ESLint](https://eslint.org/)
### Lint with [ESLint]

```sh
pnpm lint
Expand Down

0 comments on commit 2a34003

Please sign in to comment.