ClusterIQ Console

ClusterIQ Console provides a web-based user interface for the ClusterIQ project.

Deployment

This section explains how to deploy ClusterIQ Console.

Prerequisites

• Node.js 18.x or higher
• npm 8.x or higher

Quick-start (local)

git clone git@github.com:RHEcosystemAppEng/cluster-iq-console.git
cd cluster-iq-console
npm install && npm run start

Development scripts

# Install development/build dependencies
npm install

# Start the development server
npm run start

# Run a production build (outputs to "dist" dir)
npm run build

# Run the preview
npm run preview

Configurations

• TypeScript Config
• Editor Config
• Prettier Config

Code quality tools

• To keep our code formatting in check, we use prettier
• Code formatting and validation is done with Husky and lint-staged

Getting Started with Vite

This project was bootstrapped with Vite.

Available Scripts

In the project directory, you can run:

npm run start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the dist folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

See the section about deployment for more information.

npm run preview

The command will boot up a local static web server that serves the files from dist folder.

It's an easy way to check if the production build looks OK in your local environment.

See the section about deployment for more information.

Learn More

You can learn more in the Vite documentation.

To learn React, check out the React documentation.