|
1 |
| -# React + Vite |
| 1 | +# HCP CLI Assistant |
2 | 2 |
|
3 |
| -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. |
| 3 | +Click [here](https://shiftstack.github.io/hcp-cli-assistant/) to open the assistant. |
4 | 4 |
|
5 |
| -Currently, two official plugins are available: |
| 5 | +An interactive web UI wizard that helps users generate the correct `hcp create cluster openstack` command for deploying **HyperShift on OpenStack**. |
| 6 | +The assistant guides users step-by-step through required and optional configurations, ensuring a smooth setup experience. |
6 | 7 |
|
7 |
| -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh |
8 |
| -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh |
| 8 | +## Features |
| 9 | +- Step-by-step wizard for easy input |
| 10 | +- Copy-to-clipboard functionality |
9 | 11 |
|
10 |
| -## Expanding the ESLint configuration |
| 12 | +## Setup & Development |
11 | 13 |
|
12 |
| -If you are developing a production application, we recommend using TypeScript and enable type-aware lint rules. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project. |
| 14 | +### 1. Clone the Repository |
| 15 | +```sh |
| 16 | +git clone https://github.com/YOUR_GITHUB_USERNAME/hcp-cli-assistant.git |
| 17 | +cd hcp-cli-assistant |
| 18 | +``` |
| 19 | + |
| 20 | +### 2. Install Dependencies |
| 21 | +```sh |
| 22 | +npm install |
| 23 | +``` |
| 24 | + |
| 25 | +### 3. Run Locally |
| 26 | +```sh |
| 27 | +npm run dev |
| 28 | +``` |
| 29 | +Visit `http://localhost:5173/` in your browser. |
| 30 | + |
| 31 | +### 4. Build for Production |
| 32 | +```sh |
| 33 | +npm run build |
| 34 | +``` |
| 35 | + |
| 36 | +### 5. Deploy to GitHub Pages |
| 37 | +The project is automatically deployed via **GitHub Actions**, but you can also deploy manually: |
| 38 | +```sh |
| 39 | +npm run deploy |
| 40 | +``` |
| 41 | + |
| 42 | +## Access the Live App |
| 43 | +``` |
| 44 | +https://shiftstack.github.io/hcp-cli-assistant/ |
| 45 | +``` |
| 46 | + |
| 47 | +## License |
| 48 | +This project is open-source and available under the **Apache 2.0 License**. |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +Developed for HyperShift on OpenStack users. |
0 commit comments