-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
149 additions
and
153 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,161 +1,17 @@ | ||
| # How to Contribute | ||
|
|
||
| All contributions to the repository must be submitted under the terms of the | ||
| [Apache Public License 2.0](https://www.apache.org/licenses/LICENSE-2.0). | ||
|
|
||
| ## Developer Certificate of Origin | ||
|
|
||
| By contributing to this project you agree to the Developer Certificate of Origin (DCO). This | ||
| document was created by the Linux Kernel community and is a simple statement that you, as a | ||
| contributor, have the legal right to make the contribution. See the [DCO](../DCO) file for details. | ||
|
|
||
| ## About the repository's folder structure | ||
|
|
||
| This is a [monorepo](https://monorepo.tools/), as such, it's composed of many different projects. | ||
| The principal folders are: `apps` and `libs`. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. A Linux distro, like Fedora. | ||
| 2. [NodeJS](https://nodejs.org/en) > v14, or newer LTS version. | ||
| 3. [Yarn](https://yarnpkg.com/getting-started/install) | ||
| 4. This project uses `rsync` in order to synchronize .css files in one of its build steps. | ||
| 5. A back-end API to connect to. Please see instructions in | ||
| [assisted-test-infra](https://github.com/openshift/assisted-test-infra). | ||
|
|
||
| ## Setting up a local dev-environment (stand-alone) | ||
|
|
||
| 1. Create your own fork of this repo and `git clone` it. | ||
| ```bash | ||
| git clone https://github.com/<username>/assisted-installer-ui.git | ||
| ``` | ||
| 2. Create a `.env.local` file in `apps/assisted-ui/` and add the Assisted Installer API URL | ||
| ```ini | ||
| AIUI_APP_API_URL=http://<host-ip>:6008 | ||
| ``` | ||
| 3. Set up the package managers shims and install the project dependencies: | ||
| ```bash | ||
| yarn install | ||
| ``` | ||
| 4. Build the project | ||
| ```bash | ||
| yarn build:all | ||
| ``` | ||
| 5. Start the Assisted Installer UI stand-alone app | ||
| ```bash | ||
| yarn workspace @openshift-assisted/assisted-ui serve | ||
| ``` | ||
| 6. Browse to http://localhost:5173/ using a [modern web browser](https://caniuse.com/usage-table). | ||
|
|
||
| ## Integrating with uhc-portal (OCM) | ||
|
|
||
| The Assisted Installer UI is consumed as a library at build-time by other applications. | ||
| The [uhc-portal](https://gitlab.cee.redhat.com/service/uhc-portal.git) is one of them and is the | ||
| application you see at https://console.redhat.com/openshift. | ||
|
|
||
| Use this setup if you want to test the `libs/ui-lib` integration with the uhc-portal. These steps | ||
| apply for `libs/locales` as well. | ||
|
|
||
| 1. Install [yalc](https://github.com/wclr/yalc#installation) (it simulates local package registry). | ||
| ```bash | ||
| # with yarn: | ||
| yarn global add yalc | ||
| ``` | ||
| ```bash | ||
| # or with npm: | ||
| npm i -g yalc | ||
| ``` | ||
| ```bash | ||
| # then verify the command works as expected | ||
| yalc --version | ||
| ``` | ||
| 2. In one terminal run `libs/ui-lib` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/ui-lib` package to the local registry | ||
| everytime you make a change. | ||
| ```bash | ||
| yarn workspace @openshift-assisted/ui-lib watch | ||
| ``` | ||
| 3. Fork and clone the uhc-portal project | ||
| ```bash | ||
| git clone https://gitlab.cee.redhat.com/<username>/uhc-portal.git | ||
| ``` | ||
| 4. Inside the uhc-portal run the following commands | ||
| ```bash | ||
| yarn install | ||
| yalc link @openshift-assisted/ui-lib | ||
| yalc link @openshift-assisted/locales | ||
| ``` | ||
| `yalc link` needs to be executed only after cloning or pulling new changes from the uhc-portal. | ||
| **Be aware that this command updates the project's `yarn.lock` file**. | ||
| **DO NOT COMMIT THESE CHANGES INTO VERSION CONTROL.** | ||
| 5. Now you can follow the uhc-portal's | ||
| [README file](https://gitlab.cee.redhat.com/service/uhc-portal/-/blob/master/README.md) in order | ||
| to set up their dev-environment. | ||
|
|
||
| ## Integrating with CIM | ||
|
|
||
| Central infrastructure management part of Assisted Installer UI is integrated into | ||
| [stolostron/console](https://github.com/stolostron/console). | ||
|
|
||
| Use this setup if you want to test the `libs/ui-lib` integration with the stolostron/console. These | ||
| steps apply for `libs/locales` as well. | ||
|
|
||
| 1. Install [yalc](https://github.com/wclr/yalc#installation) (it simulates local package registry). | ||
| ```bash | ||
| # with yarn: | ||
| yarn global add yalc | ||
| ``` | ||
| ```bash | ||
| # or with npm: | ||
| npm i -g yalc | ||
| ``` | ||
| ```bash | ||
| # then verify the command works as expected | ||
| yalc --version | ||
| ``` | ||
| 2. In one terminal run `libs/ui-lib` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/ui-lib` package to the local registry | ||
| everytime you make a change. | ||
|
|
||
| ```bash | ||
| yarn workspace @openshift-assisted/ui-lib watch | ||
| ``` | ||
|
|
||
| 3. In another terminal run `libs/locales` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/locales` package to the local registry | ||
| everytime you make a change. | ||
|
|
||
| ```bash | ||
| yarn workspace @openshift-assisted/locales watch | ||
| ``` | ||
|
|
||
| 4. Follow the stolostron/console | ||
| [development setup guide](https://github.com/stolostron/console#running). | ||
| 5. To use locally published @openshift-assisted packages inside the stolostron/console run the | ||
| following commands | ||
| ```bash | ||
| cd frontend | ||
| yalc link @openshift-assisted/ui-lib | ||
| yalc link @openshift-assisted/locales | ||
| ``` | ||
| Note that these commands need to be re-executed every time the `npm install` is run in the | ||
| `frontend` directory. | ||
|
|
||
| ## Updating the API types | ||
|
|
||
| The TypeScript types used by Assisted Installer UI are generated automatically from the | ||
| assisted-service's swagger file. | ||
| These can be generated automatically by running: | ||
| ``` | ||
| yarn workspace @openshift-assisted/ui-lib update-api | ||
| ``` | ||
| ## Unit testing | ||
| This project uses [Vitest](https://vitest.dev/api/) for unit testing. | ||
| To run existing unit tests, call | ||
| contributor, have the legal right to make the contribution. See the [DCO](./DCO) file for details. | ||
|
|
||
| ``` | ||
| yarn test:unit | ||
| ``` | ||
| ## Contributing A Patch | ||
|
|
||
| To write a unit test, simply create/update a `*.test.ts` file. | ||
| 1. Submit an issue describing your proposed change to the repo in question. | ||
| 2. The repo owners will respond to your issue promptly. | ||
| 3. Fork the desired repo, develop and test your code changes. | ||
| 4. Submit a pull request. |
File renamed without changes.
This file contains 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,140 @@ | ||
| # Development | ||
|
|
||
| The project is developed in a [monorepo](https://monorepo.tools/), as such, it differentiates | ||
| between applications and libraries. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. A Linux distro, like Fedora. | ||
| 2. [NodeJS](https://nodejs.org/en) > v14, or newer LTS version. | ||
| 3. [Yarn](https://yarnpkg.com/getting-started/install) | ||
| 4. This project uses `rsync` in order to synchronize .css files in one of its build steps. | ||
| 5. A back-end API to connect to. Please see instructions in | ||
| [assisted-test-infra](https://github.com/openshift/assisted-test-infra). | ||
| 6. Install [yalc](https://github.com/wclr/yalc#installation) (it simulates local package registry). | ||
| ```bash | ||
| # with yarn: | ||
| yarn global add yalc | ||
| ``` | ||
| ```bash | ||
| # or with npm: | ||
| npm i -g yalc | ||
| ``` | ||
| ```bash | ||
| # then verify the command works as expected | ||
| yalc --version | ||
| ``` | ||
|
|
||
| ## Setting up a local dev-environment (stand-alone) | ||
|
|
||
| 1. Create your own fork of this repo and `git clone` it. | ||
| ```bash | ||
| git clone https://github.com/<username>/assisted-installer-ui.git | ||
| ``` | ||
| 2. Create a `.env.local` file in `apps/assisted-ui/` and add the Assisted Installer API URL | ||
| ```ini | ||
| AIUI_APP_API_URL=http://<host-ip>:6008 | ||
| ``` | ||
| 3. Set up the package managers shims and install the project dependencies: | ||
| ```bash | ||
| yarn install | ||
| ``` | ||
| 4. Build the project | ||
| ```bash | ||
| yarn build:all | ||
| ``` | ||
| 5. Start the Assisted Installer UI stand-alone app | ||
| ```bash | ||
| yarn workspace @openshift-assisted/assisted-ui serve | ||
| ``` | ||
| 6. Browse to http://localhost:5173/ using a [modern web browser](https://caniuse.com/usage-table). | ||
|
|
||
| ## Integrating with OCM (uhc-portal) | ||
|
|
||
| The Assisted Installer UI is consumed as a library at build-time by other applications. | ||
| The [uhc-portal](https://gitlab.cee.redhat.com/service/uhc-portal.git) is one of them and is the | ||
| application you see at https://console.redhat.com/openshift. | ||
|
|
||
| Use this setup if you want to test the `libs/ui-lib` integration with the uhc-portal. These steps | ||
| apply for `libs/locales` as well. | ||
|
|
||
| 1. In one terminal run `libs/ui-lib` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/ui-lib` package to the local registry | ||
| everytime you make a change. | ||
| ```bash | ||
| yarn workspace @openshift-assisted/ui-lib watch | ||
| ``` | ||
| 2. Fork and clone the uhc-portal project | ||
| ```bash | ||
| git clone https://gitlab.cee.redhat.com/<username>/uhc-portal.git | ||
| ``` | ||
| 3. Inside the uhc-portal run the following commands | ||
| ```bash | ||
| yarn install | ||
| yalc link @openshift-assisted/ui-lib | ||
| yalc link @openshift-assisted/locales | ||
| ``` | ||
| `yalc link` needs to be executed only after cloning or pulling new changes from the uhc-portal. | ||
| **Be aware that this command updates the project's `yarn.lock` file**. | ||
| **DO NOT COMMIT THESE CHANGES INTO VERSION CONTROL.** | ||
| 4. Now you can follow the uhc-portal's | ||
| [README file](https://gitlab.cee.redhat.com/service/uhc-portal/-/blob/master/README.md) in order | ||
| to set up their dev-environment. | ||
|
|
||
| ## Integrating with the Openshift Console for ACM and MCE (aka CIM) | ||
|
|
||
| Some components of the Assisted Installer UI are integrated into the Central Infrastructure | ||
| Management [stolostron/console](https://github.com/stolostron/console). | ||
|
|
||
| Follow these steps if you want to test the `libs/ui-lib` integration within `stolostron/console`. | ||
| These steps apply for `libs/locales` as well. | ||
|
|
||
| 1. In one terminal run `libs/ui-lib` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/ui-lib` package to the local registry | ||
| everytime you make a change. | ||
|
|
||
| ```bash | ||
| yarn workspace @openshift-assisted/ui-lib watch | ||
| ``` | ||
|
|
||
| 2. In another terminal run `libs/locales` in watch mode. | ||
| The script builds and publishes the `@openshift-assisted/locales` package to the local registry | ||
| everytime you make a change. | ||
|
|
||
| ```bash | ||
| yarn workspace @openshift-assisted/locales watch | ||
| ``` | ||
|
|
||
| 3. Follow the stolostron/console | ||
| [development setup guide](https://github.com/stolostron/console#running). | ||
| 4. To use locally published @openshift-assisted packages inside the stolostron/console run the | ||
| following commands | ||
| ```bash | ||
| cd frontend | ||
| yalc link @openshift-assisted/ui-lib | ||
| yalc link @openshift-assisted/locales | ||
| ``` | ||
| Note that these commands need to be re-executed every time the `npm install` is run in the | ||
| `frontend` directory. | ||
|
|
||
| ## Updating the API types | ||
|
|
||
| The TypeScript types used by Assisted Installer UI are generated automatically from the | ||
| assisted-service's swagger file. | ||
| These can be generated automatically by running: | ||
| ``` | ||
| yarn workspace @openshift-assisted/ui-lib update-api | ||
| ``` | ||
| ## Unit testing | ||
| This project uses [Vitest](https://vitest.dev/api/) for unit testing. | ||
| To run existing unit tests, call | ||
| ``` | ||
| yarn test:unit | ||
| ``` | ||
| To write a unit test, simply create/update a `*.test.ts` file. |