-
Notifications
You must be signed in to change notification settings - Fork 599
HDDS-14519. Setup ozone-ui module for common UI code #9684
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
4593d99
HDDS-14519. Setup hadoop-ui module for all UI code
spacemonkd 621c1f8
Delete ReadMe file from Recon folder and move it to src
spacemonkd 4da03ac
Address review comments, add CI checks
spacemonkd fd07512
Address RAT issues
spacemonkd b55f1d5
Address RAT issues and add UI checkstyle checks
spacemonkd ad260f3
Fix workflows
spacemonkd 8dd0b69
Add UI checkstyle command fixes
spacemonkd be13e82
Add separate checkstyle step to run UI lint along with mvn checkstyle
spacemonkd a4007b7
Modify checkstyle to either run mvn or eslint
spacemonkd 206b174
Enable pnpm via corepack, add check to install node modules if not al…
spacemonkd 31a83bd
Fixed lockfile
spacemonkd dab6cd5
Output the failures into the GH actions output
spacemonkd ef6354d
Address prettier and linter issues
spacemonkd edbb187
Add prettierrc as json
spacemonkd a34f80d
Address review comments
spacemonkd e936b1f
Address review comments
spacemonkd b044d8a
Fix lint.sh, also fail some prettier checks for CI test
spacemonkd 5b92a7a
Run UI lint in case of a commit
spacemonkd f9afa52
Fix linter summary output
spacemonkd a4c6585
Fix summary for lint.sh
spacemonkd b14ea65
Fix linter errors
spacemonkd a6b7463
Address review comments
spacemonkd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Logs | ||
| logs | ||
| *.log | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| pnpm-debug.log* | ||
| lerna-debug.log* | ||
|
|
||
| node_modules | ||
| dist | ||
| build | ||
| *.local | ||
|
|
||
| # Editor directories and files | ||
| .vscode/* | ||
| !.vscode/extensions.json | ||
| .idea | ||
| .DS_Store | ||
| *.suo | ||
| *.ntvs* | ||
| *.njsproj | ||
| *.sln | ||
| *.sw? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!--- | ||
| Licensed to the Apache Software Foundation (ASF) under one or more | ||
| contributor license agreements. See the NOTICE file distributed with | ||
| this work for additional information regarding copyright ownership. | ||
| The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| (the "License"); you may not use this file except in compliance with | ||
| the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # Hadoop UI Monorepo | ||
|
spacemonkd marked this conversation as resolved.
Outdated
|
||
|
|
||
| This monorepo contains three React applications for Apache Ozone HDDS UI components: | ||
|
spacemonkd marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Applications | ||
|
|
||
| - **Recon** - Data node management and monitoring | ||
| - **SCM** - Storage Container Manager interface | ||
| - **OM** - Ozone Manager interface | ||
|
|
||
| ## Structure | ||
|
|
||
| ``` | ||
| hadoop-ui/src/ | ||
| ├── packages/ | ||
| │ ├── shared/ # Shared components and utilities | ||
| │ ├── recon/ # Recon application | ||
| │ ├── scm/ # SCM application | ||
| │ └── om/ # OM application | ||
| ├── package.json # Root package.json with workspace configuration | ||
| └── pnpm-workspace.yaml # PNPM workspace configuration | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node.js >= 20.0.0 (Node 20 LTS recommended) | ||
| - PNPM >= 8.0.0 | ||
|
|
||
| ### Installation | ||
|
|
||
| ```bash | ||
| # Install all dependencies | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| ```bash | ||
| # Start development server for a specific app | ||
| pnpm dev:recon | ||
| pnpm dev:scm | ||
| pnpm dev:om | ||
|
|
||
| # Build shared components (run this first if you make changes to shared) | ||
| pnpm build:shared | ||
| ``` | ||
|
|
||
| ### Building | ||
|
|
||
| ```bash | ||
| # Build all applications | ||
| pnpm build | ||
|
|
||
| # Build specific application | ||
| pnpm build:recon | ||
| pnpm build:scm | ||
| pnpm build:om | ||
|
|
||
| # Build only shared components | ||
| pnpm build:shared | ||
| ``` | ||
|
|
||
| Build outputs are placed in: | ||
| - `build/recon/` - Recon application build | ||
| - `build/scm/` - SCM application build | ||
| - `build/om/` - OM application build | ||
|
|
||
| ### Clean | ||
|
|
||
| ```bash | ||
| # Clean all build artifacts and node_modules | ||
| pnpm clean | ||
| ``` | ||
|
|
||
| ## Architecture | ||
|
|
||
| ### Shared Components | ||
|
|
||
| The `@hadoop-ui/shared` package contains: | ||
|
|
||
| - **Components**: Reusable React components (e.g., Sidebar) | ||
| - **Utils**: Shared utility functions (e.g., menu utilities) | ||
| - **Types**: TypeScript type definitions | ||
|
|
||
| ### Individual Applications | ||
|
|
||
| Each application (`recon`, `scm`, `om`) is a standalone Vite + React + TypeScript application that can import from the shared package. | ||
|
|
||
| ## Technology Stack | ||
|
|
||
| - **Build Tool**: Vite | ||
| - **Framework**: React 18 | ||
| - **Language**: TypeScript | ||
| - **UI Library**: Ant Design v5 | ||
| - **Package Manager**: PNPM (with workspaces) | ||
| - **Monorepo**: PNPM Workspaces | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| dist | ||
| build | ||
| node_modules | ||
| pnpm-lock.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "printWidth": 100, | ||
| "singleQuote": true, | ||
| "trailingComma": "all", | ||
| "semi": true, | ||
| "tabWidth": 2, | ||
| "endOfLine": "lf" | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.