particle-os/debian-image-builder-frontend

Image Builder service for console.redhat.com

Find a file

Sanne Raymaekers d09108aef2 config: Move deployment under general webpack config `deployment` is not specific to the proxy.		2022-04-12 20:03:38 +02:00
.github	ci: Extract Coverity Scan tools in /tmp	2021-11-12 12:02:43 +01:00
.travis	travis: Fork main to prod-beta	2021-03-19 11:15:52 +01:00
config	config: Move deployment under general webpack config	2022-04-12 20:03:38 +02:00
devel	devel: typo fix (#561 )	2022-02-07 20:36:23 +01:00
distribution	Reflect webpack changes in docker compose.	2021-10-12 15:03:04 +02:00
src	test: Wait for rendering to finish in keyboard accessability test	2022-04-12 13:07:50 +02:00
.eslintrc.yml	package.json: update babel-eslint to @babel/eslint-parser	2022-03-02 09:59:19 +01:00
.gitignore	Stop ignoring lock-file.	2021-10-12 15:03:04 +02:00
.stylelintrc.json	package-json: remove unnused stylint-scss and bump dependencies	2022-03-24 15:48:34 +01:00
.travis.yml	package.json: Simplify scripts	2022-04-12 20:03:38 +02:00
babel.config.js	babel: update the babel config	2022-04-11 13:18:30 +02:00
codecov.yml	codecov.yml: reset comment to default	2021-10-28 15:02:18 +01:00
LICENSE	osbuild-installer-frontend	2020-03-27 10:14:04 +01:00
package-lock.json	build(deps): bump @patternfly/patternfly from 4.183.1 to 4.185.1	2022-04-12 12:48:22 +02:00
package.json	package.json: Simplify scripts	2022-04-12 20:03:38 +02:00
README.md	package.json: add run script for stage env	2022-02-28 15:35:51 +01:00

README.md

image-builder-frontend

Frontend Development

To develop the frontend you can use a proxy to run image-builder-frontend locally against the chrome and backend at console.redhat.com.

Working against the production environment is preferred, as any work can be released without worrying if a feature from stage has been released yet.

Nodejs and npm version

Make sure you have npm@7 and node 15+ installed. If you need multiple versions of nodejs check out nvm.

Webpack proxy

run npm ci
run npm run start:proxy:beta. This command uses a prod-beta env by default. Configure your environment by the env attribute in dev.webpack.config.js.
open browser at https://prod.foo.redhat.com:1337/beta/insights/image-builder

Webpack proxy (staging) -- Runs with image-builder's stage deployment

run npm ci
run npm run stage. This command uses a stage-beta env by default. Configure your environment by the env attribute in dev.webpack.config.js.
open browser at https://stage.foo.redhat.com:1337/beta/insights/image-builder

Insights proxy (deprecated)

Clone the insights proxy: https://github.com/RedHatInsights/insights-proxy

Setting up the proxy

Choose a runner (podman or docker), and point the SPANDX_CONFIG variable to profile/local-frontend.js included in image-builder-frontend.

    sudo insights-proxy/scripts/patch-etc-hosts.sh
    export RUNNER="podman"
    export SPANDX_CONFIG=$PATH_TO/image-builder-frontend/profiles/local-frontend.js
    sudo -E insights-proxy/scripts/run.sh

Starting up image-builder-frontend

In the image-builder-frontend checkout directory
```
    npm install
    npm start
```

The UI should be running on https://prod.foo.redhat.com:1337/beta/insights/image-builder/landing. Note that this requires you to have access to either production or stage (plus VPN and proxy config) of insights.

Backend Development

To develop both the frontend and the backend you can again use the proxy to run both the frontend and backend locally against the chrome at cloud.redhat.com. For instructions see devel/README.md.

Style Guidelines

This project uses eslint's recommended styling guidelines. These rules can be found here: https://eslint.org/docs/rules/

Test Guidelines

Testing is done using React Testing Library. All UI contributions must also include a new test or update an existing test in order to maintain code coverage.

Tests can be run with

    npm run test

These tests will also be run in our Travis CI when a PR is opened.