An open API service indexing awesome lists of open source software.

https://github.com/adamj/rhd-frontend-react

A React version of the rhd-frontend repo using PatternFly-React (v4)
https://github.com/adamj/rhd-frontend-react

Last synced: 3 months ago
JSON representation

A React version of the rhd-frontend repo using PatternFly-React (v4)

Awesome Lists containing this project

README

          

# RHD Frontend w/React
This is a demo repo of the RHD Frontend running on React. For demonstration purposes only.

Based off of the [PatternFly Seed](https://github.com/patternfly/patternfly-react-seed) repository.

----

## Patternfly Seed

Patternfly Seed is an open source build scaffolding utility for web apps. The primary purpose of this project is to give developers a jump start when creating new projects that will use patternfly. A secondary purpose of this project is to serve as a reference for how to configure various aspects of an application that uses patternfly, webpack, react, typescript, etc.

Out of the box you'll get an app layout with chrome (header/sidebar), routing, build pipeline, test suite, and some code quality tools. Basically, all the essentials.

Out of box dashboard view of patternfly seed

### Quick-start
```bash
npm install yarn -g # ensure you have yarn on your machine globally
git clone https://github.com/patternfly/patternfly-react-seed # clone the project
cd patternfly-react-seed # navigate into the project directory
yarn # install patternfly-react-seed dependencies
yarn build # build the project
yarn start # start the development server
```
### Development Scripts

Install development/build dependencies
`yarn`

Start the development server
`yarn start`

Run a production build
`yarn build`

Run the test suite
`yarn test`

Run the linter
`yarn lint`

Run the code formatter
`yarn format`

Launch a tool to inspect the bundle size
`yarn bundle-profile:analyze`

### Configurations
* [TypeScript Config](./tsconfig.json)
* [Webpack Config](./webpack.common.js)
* [Jest Config](./jest.config.js)
* [Editor Config](./.editorconfig)

### Raster Image Support

To use an image asset that's shipped with patternfly core, you'll prefix the paths with "@assets". `@assets` is an alias for the patternfly assets directory in node_modules.

For example:
```js
import imgSrc from '@assets/images/g_sizing.png';
Some image
```

You can use a similar technique to import assets from your local app, just prefix the paths with "@app". `@app` is an alias for the main src/app directory.

```js
import loader from '@app/assets/images/loader.gif';
Content loading />
<br />```</p>

<p>### Vector Image Support
<br />Inlining SVG in the app's markup is also possible.</p>

<p>```js
<br />import logo from '@app/assets/images/logo.svg';
<br /><span dangerouslySetInnerHTML={{__html: logo}} />
<br />```</p>

<p>You can also use SVG when applying background images with CSS. To do this, your SVG's must live under a `bgimages` directory (this directory name is configurable in [webpack.common.js](./webpack.common.js#L5)). This is necessary because you may need to use SVG's in several other context (inline images, fonts, icons, etc.) and so we need to be able to differentiate between these usages so the appropriate loader is invoked.
<br />```css
<br />body {
<br />  background: url(./assets/bgimages/img_avatar.svg);
<br />}
<br />```</p>

<p>### Code Quality Tools
<br />* For accessibility compliance, we use [react-axe](https://github.com/dequelabs/react-axe)
<br />* To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)
<br />* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier)
<br />* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest)
<br />