# metal3-facet
> OpenShift Metal³ installer UI.
Latest version **0.1.4** (published 2020-05-20) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install metal3-facet
pnpm add metal3-facet
yarn add metal3-facet
bun add metal3-facet
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.4 |
| Published | 2020-05-20 |
| First published | 2020-05-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 49 |
| Unpacked size | 482.1 KB |
| Known vulnerabilities | 0 (+30 in 3 direct dependencies) |
| Install scripts | no |
| Maintainers | mareklibra |
## Links
- npm: https://www.npmjs.com/package/metal3-facet
- Issues: https://github.com/openshift-metal3/facet/issues
- npm.io page: https://npm.io/package/metal3-facet
## Dependencies (49)
- [yup](https://npm.io/package/yup.md) ^0.28.3
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [react](https://npm.io/package/react.md) ^16.13.0
- [redux](https://npm.io/package/redux.md) ^4.0.5
- [eslint](https://npm.io/package/eslint.md) ^6.8.0
- [formik](https://npm.io/package/formik.md) ^2.1.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [sw2dts](https://npm.io/package/sw2dts.md) ^2.6.2
- [prettier](https://npm.io/package/prettier.md) ^2.0.1
- [reselect](https://npm.io/package/reselect.md) ^4.0.0
- [node-sass](https://npm.io/package/node-sass.md) ^4.13.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.0
- [@types/yup](https://npm.io/package/@types/yup.md) ^0.26.9
- [file-saver](https://npm.io/package/file-saver.md) ^2.0.2
- [typescript](https://npm.io/package/typescript.md) ^3.8.3
- [@types/jest](https://npm.io/package/@types/jest.md) ^24.0.0
- [@types/node](https://npm.io/package/@types/node.md) ^12.0.0
- [react-redux](https://npm.io/package/react-redux.md) ^7.2.0
- [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.3.0
- [@types/react](https://npm.io/package/@types/react.md) ^16.9.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.121
- [humanize-plus](https://npm.io/package/humanize-plus.md) ^1.8.2
- [react-scripts](https://npm.io/package/react-scripts.md) 3.4.0
- [@tippy.js/react](https://npm.io/package/@tippy.js/react.md) ^3.1.1
- [@reduxjs/toolkit](https://npm.io/package/@reduxjs/toolkit.md) ^1.3.5
- [@types/react-dom](https://npm.io/package/@types/react-dom.md) ^16.9.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.1.2
- [@types/file-saver](https://npm.io/package/@types/file-saver.md) ^2.0.1
- [@types/react-redux](https://npm.io/package/@types/react-redux.md) ^7.1.7
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.19.0
- [@types/humanize-plus](https://npm.io/package/@types/humanize-plus.md) ^1.8.0
- [axios-case-converter](https://npm.io/package/axios-case-converter.md) ^0.6.0
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^1.0.3
- [@patternfly/patternfly](https://npm.io/package/@patternfly/patternfly.md) ^2.68.4
- [@patternfly/react-core](https://npm.io/package/@patternfly/react-core.md) ^3.146.0
- [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^9.3.2
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^6.10.1
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.1.2
- [unique-names-generator](https://npm.io/package/unique-names-generator.md) ^4.2.0
- [@patternfly/react-icons](https://npm.io/package/@patternfly/react-icons.md) ^3.15.12
- [@patternfly/react-table](https://npm.io/package/@patternfly/react-table.md) 2.28.47
- [@types/react-router-dom](https://npm.io/package/@types/react-router-dom.md) ^5.1.3
- [@patternfly/react-tokens](https://npm.io/package/@patternfly/react-tokens.md) ^2.8.8
- [redux-devtools-extension](https://npm.io/package/redux-devtools-extension.md) ^2.13.8
- [@testing-library/jest-dom](https://npm.io/package/@testing-library/jest-dom.md) ^4.2.4
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^2.24.0
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^2.5.0
- [@testing-library/user-event](https://npm.io/package/@testing-library/user-event.md) ^7.1.2
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^2.24.0
## Recent versions
- 0.1.4 (latest) — 2020-05-20
- 0.1.3 — 2020-05-11
- 0.1.1 — 2020-05-07
## README
# Facet
OpenShift Metal³ installer UI.
Facet is the central integration point for doing a Metal³ deployment of OpenShift. It’s the one
command you run on a provisioning host to kick off the deployment. It performs the following
functions:
- Implements the day 1 provisioning API. In other words, this API provides what is necessary to get
the masters providing the control plane up and running. From that point, the Machine API and the
corresponding Metal³ components will take over provisioning the rest of the cluster.
- Will do provisioning host configuration validation at startup.
- Will launch the Ironic containers using podman on the provisioning host.
- Will download the current images of RHCOS that are needed for deployment. (for the bootstrap VM
and bare metal hosts)
- Will run the installer, launch the bootstrap VM, and drive Ironic APIs.
Here's a diagram of the Facet architecture: 
For further details about the Metal³ architecture, see [http://github.com/metal3-io/metal3-docs].
## Getting started
- Install [yarn][1]
- Install javascript dependencies with `yarn install`
- Start the yarn server with:
```
REACT_APP_API_URL=`minikube service bm-inventory --url` yarn start
```
- Open the UI at `http://localhost:3000`
[1]: https://yarnpkg.com/en/
## Running the production server
TBD
## Production build
You can compile the production executable by running:
```
$ yarn build
```
## Available Scripts
In the project directory, you can run:
### `hacks/npm-publish.sh`
Increases `patch` version (`.z`) of the package, opens PR with this change and **publishes** the
package to the [npmjs.com](https://www.npmjs.com/package/metal3-facet) repository.
New tag conforming the version is created.
Prior running this script, please be sure you
- are logged in npmjs.com (call `yarn login`)
- can create branches and open PRs in
[https://github.com/openshift-metal3/facet](https://github.com/openshift-metal3/facet)
### `yarn install`
Installs dependencies to node_modules directory
### `yarn prettier`
This application uses Prettier to check and format code. You can run the above command to clean your
code, or you can [integrate it with your editor](https://prettier.io/docs/en/editors.html), and set
up a Prettier extenson and formatting changes will automatically be applied when you save.
### `yarn start`
Runs the app in the development mode.
Open [http://localhost:3000](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.
### `yarn test`
Launches the test runner in the interactive watch mode.
See the section about
[running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more
information.
### `yarn test-suite`
Runs the GUI tests, based on Protrator (Selenium). Make sure you run `yarn webdriver-update` at
least once before using protractor, in order to download the needed Selenium web drivers.
You can also run a specific suite with: yarn test-suite --suite
### `yarn webdriver-update`
Downloads the Selenium web drivers for Firefox and Chrome. Run it at least once before trying to run
the test-suite which uses Protractor. You also need to re-run this after every `yarn install` or
update to the node modules.
### `yarn run build`
Builds the app for production to the `build` folder.
It correctly bundles React in production
mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for
more information.
### `yarn run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.
This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel,
ESLint, etc) right into your project so you have full control over them. All of the commands except
`eject` will still work, but they will point to the copied scripts so you can tweak them. At this
point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle
deployments, and you shouldn’t feel obligated to use this feature. However we understand that this
tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the
[Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
---
_Source: https://npm.io/package/metal3-facet · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._