binarycat0 commented on code in PR #85: URL: https://github.com/apache/polaris-tools/pull/85#discussion_r2582436147
########## console/README.md: ########## @@ -0,0 +1,130 @@ +<!-- +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. +--> + +# Polaris Console + +A modern web interface for Apache Polaris, built with React, TypeScript, TanStack Query, and Tailwind CSS. + +## Getting Started + +### Prerequisites +- Node.js 18+ and npm (or yarn) + +### Installation + +```bash +# Install dependencies +npm install + +# Start development server +npm run dev + +# Build for production +npm run build +``` + +### Environment Variables + +Create a `.env` file based on `.env.example`: + +```env +VITE_POLARIS_API_URL=http://localhost:8181 +VITE_POLARIS_REALM=POLARIS +VITE_POLARIS_REALM_HEADER_NAME=Polaris-Realm # optional, defaults to "Polaris-Realm" +VITE_OAUTH_TOKEN_URL=http://localhost:8181/api/v1/oauth/tokens # optional +``` + +## Project Structure + +``` +src/ +├── api/ # API client and endpoints +│ ├── client.ts # Axios instance with interceptors +│ ├── auth.ts # Authentication API +│ └── management/ # Management Service APIs +├── components/ # React components +│ ├── ui/ # Shadcn UI components +│ ├── layout/ # Layout components +│ └── forms/ # Form components +├── hooks/ # Custom React hooks +├── lib/ # Utilities +├── pages/ # Page components +├── types/ # TypeScript type definitions +└── App.tsx # Main app component +``` + +## Technology Stack + +- **Framework**: React 19 with TypeScript +- **Routing**: React Router v7 +- **State Management**: TanStack Query (React Query) +- **Tables**: TanStack Table (React Table) +- **Styling**: Tailwind CSS +- **Components**: Shadcn UI (Radix UI primitives) +- **Forms**: React Hook Form with Zod validation +- **HTTP Client**: Axios +- **Icons**: Lucide React + +## Development + +The project uses: +- Vite for fast development and building +- ESLint for code linting +- TypeScript for type safety + +To start developing: + +```bash +npm run dev +``` + +The app will be available at `http://localhost:5173` + +## Building + +```bash +npm run build +``` + +Output will be in the `dist/` directory. + +## Production Deployment + +After building, you can serve the production files in several ways: + +### Quick Test +```bash +bun run preview # or npm run preview +``` + +## Docker image + +You can build Polaris Console docker image using: + +``` +docker build -t apache/polaris-console:latest . +``` + +Then, you run Polaris Console using: + +``` +docker run -p 8080:80 apache/polaris-console:latest Review Comment: delivered here https://github.com/apache/polaris-tools/pull/85/commits/358425d6da1264f39d605f6ecd0ffc9a19f3ab71 added [how-to](https://github.com/jbonofre/polaris-tools/tree/ui/console#k8s-deployment-with-helm) into the readme -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
