particle-os/debian-image-builder-frontend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Image Builder service for console.redhat.com
390 commits 9 branches 22 tags 26 MiB
Find a file
Alexander Todorov 6b951288c7 ci: Extract Coverity Scan tools in /tmp 
this will prevent the tool from scanning itself
2021-11-12 12:02:43 +01: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: Use correct sassPrefixes in production 2021-10-19 15:32:36 +02:00
devel devel: re-use existing dashboards 2021-10-29 11:02:22 +01:00
distribution Reflect webpack changes in docker compose. 2021-10-12 15:03:04 +02:00
profiles src: Adapt to insights-chrome 2.0 2021-05-06 11:26:41 +02:00
src CreateImageWizard: fix indentation in the review step 2021-11-11 22:44:21 +00:00
tools tools: Make make-bots executable 2020-10-27 18:09:24 +01:00
.babelrc copy from RedHatInsights/insights-frontend-starter-app template 2020-04-15 12:46:02 +02:00
.eslintrc.yml package.json: Pin exact versions 2021-04-12 15:58:58 +02:00
.gitignore Stop ignoring lock-file. 2021-10-12 15:03:04 +02:00
.stylelintrc.json copy from RedHatInsights/insights-frontend-starter-app template 2020-04-15 12:46:02 +02:00
.travis.yml Require npm@7 to install dependencies. 2021-10-12 15:03:04 +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 package.json: update eslint to 7.32.0 2021-11-11 22:44:21 +00:00
package.json package.json: update eslint to 7.32.0 2021-11-11 22:44:21 +00:00
README.md README: Newline at eof 2021-10-12 15:44:48 +02: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

  1. run npm i

  2. 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.

  3. open browser at https://prod.foo.redhat.com:1337/beta/insights/image-builder

Insights proxy (deprecated)

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

  2. 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

  3. 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.