apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
d315ff5055
celeborn/web
History
tiny-dust d315ff5055 [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 
![image](https://github.com/apache/incubator-celeborn/assets/49502875/4404770c-c46e-470b-8f5e-c244c6656339)

### What changes were proposed in this pull request?

- Added Husky to enforce code quality with automated tasks during Git events.
- Added lint-staged for optimized linting on staged files before each commit.

### Why are the changes needed?

Enhances code quality.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Local test.

Closes #2250 from tiny-dust/CELEBORN-1240.

Lead-authored-by: tiny-dust <idioticzhou@foxmail.com>
Co-authored-by: 周顺顺 <idioticzhou@foxmail.com>
Signed-off-by: SteNicholas <programgeek@163.com>
2024-01-26 16:23:42 +08:00
..
.husky [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 2024-01-26 16:23:42 +08:00
.vscode [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
public [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
src [CELEBORN-1232] Add Menu to Celeborn Web 2024-01-22 15:15:05 +08:00
.eslintrc.cjs [CELEBORN-1232] Add Menu to Celeborn Web 2024-01-22 15:15:05 +08:00
.gitignore [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
.prettierrc.json [CELEBORN-1232] Add Menu to Celeborn Web 2024-01-22 15:15:05 +08:00
env.d.ts [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
index.html [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
package.json [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 2024-01-26 16:23:42 +08:00
pnpm-lock.yaml [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 2024-01-26 16:23:42 +08:00
pom.xml [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 2024-01-26 16:23:42 +08:00
README.md [CELEBORN-1240] Introduce Husky Configuration to Celeborn Web 2024-01-26 16:23:42 +08:00
tsconfig.app.json [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
tsconfig.json [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
tsconfig.node.json [CELEBORN-1231] Support baseline implementation of Celeborn Web 2024-01-19 15:55:10 +08:00
vite.config.ts [CELEBORN-1232] Add Menu to Celeborn Web 2024-01-22 15:15:05 +08:00

README.md

Celeborn Web UI

Celeborn Web is a dashboard to display and manage the Master and Worker of Celeborn. This document introduces how to install and build the UI of Celeborn Web.

⚠️ Important

Before running commands, you must ensure that you are in the front-end directory incubator-celeborn/web. If not, run cd web first.

Getting started

Preparation | Framework & Dependencies

Tip

You should use the Pnpm package manager.

Installation

Development environment

  • Run the below command in the console to install the required dependencies.
pnpm install

Compile and Hot-Reload for Development

pnpm dev

Type-Check, Compile and Minify for Production

pnpm build

Lint with ESLint

# Whole project
pnpm lint

# Staged files for commit
pnpm lint:lint-staged