|
| 1 | +# Patternfly Seed |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +<img width="1058" alt="Out of box dashboard view of patternfly seed" src="https://github.com/user-attachments/assets/0227b366-67f1-4df8-8d92-e8e95d6e08b3" /> |
| 8 | + |
| 9 | +## Quick-start |
| 10 | + |
| 11 | +```bash |
| 12 | +git clone https://github.com/patternfly/patternfly-react-seed |
| 13 | +cd patternfly-react-seed |
| 14 | +npm install && npm run start:dev |
| 15 | +``` |
| 16 | +## Development scripts |
| 17 | +```sh |
| 18 | +# Install development/build dependencies |
| 19 | +npm install |
| 20 | + |
| 21 | +# Start the development server |
| 22 | +npm run start:dev |
| 23 | + |
| 24 | +# Run a production build (outputs to "dist" dir) |
| 25 | +npm run build |
| 26 | + |
| 27 | +# Run the test suite |
| 28 | +npm run test |
| 29 | + |
| 30 | +# Run the test suite with coverage |
| 31 | +npm run test:coverage |
| 32 | + |
| 33 | +# Run the linter |
| 34 | +npm run lint |
| 35 | + |
| 36 | +# Run the code formatter |
| 37 | +npm run format |
| 38 | + |
| 39 | +# Launch a tool to inspect the bundle size |
| 40 | +npm run bundle-profile:analyze |
| 41 | + |
| 42 | +# Start the express server (run a production build first) |
| 43 | +npm run start |
| 44 | +``` |
| 45 | + |
| 46 | +## Configurations |
| 47 | +* [TypeScript Config](./tsconfig.json) |
| 48 | +* [Webpack Config](./webpack.common.js) |
| 49 | +* [Jest Config](./jest.config.js) |
| 50 | +* [Editor Config](./.editorconfig) |
| 51 | + |
| 52 | +## Raster image support |
| 53 | + |
| 54 | +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. |
| 55 | + |
| 56 | +For example: |
| 57 | +```js |
| 58 | +import imgSrc from '@assets/images/g_sizing.png'; |
| 59 | +<img src={imgSrc} alt="Some image" /> |
| 60 | +``` |
| 61 | + |
| 62 | +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. |
| 63 | + |
| 64 | +```js |
| 65 | +import loader from '@app/assets/images/loader.gif'; |
| 66 | +<img src={loader} alt="Content loading" /> |
| 67 | +``` |
| 68 | + |
| 69 | +## Vector image support |
| 70 | +Inlining SVG in the app's markup is also possible. |
| 71 | + |
| 72 | +```js |
| 73 | +import logo from '@app/assets/images/logo.svg'; |
| 74 | +<span dangerouslySetInnerHTML={{__html: logo}} /> |
| 75 | +``` |
| 76 | + |
| 77 | +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. |
| 78 | +```css |
| 79 | +body { |
| 80 | + background: url(./assets/bgimages/img_avatar.svg); |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +## Adding custom CSS |
| 85 | +When importing CSS from a third-party package for the first time, you may encounter the error `Module parse failed: Unexpected token... You may need an appropriate loader to handle this file typ...`. You need to register the path to the stylesheet directory in [stylePaths.js](./stylePaths.js). We specify these explicitly for performance reasons to avoid webpack needing to crawl through the entire node_modules directory when parsing CSS modules. |
| 86 | + |
| 87 | +## Code quality tools |
| 88 | +* For accessibility compliance, we use [react-axe](https://github.com/dequelabs/react-axe) |
| 89 | +* To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) |
| 90 | +* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier) |
| 91 | +* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest) |
| 92 | +* To ensure code styles remain consistent, we use [eslint](https://eslint.org/) |
| 93 | + |
| 94 | +## Multi environment configuration |
| 95 | +This project uses [dotenv-webpack](https://www.npmjs.com/package/dotenv-webpack) for exposing environment variables to your code. Either export them at the system level like `export MY_ENV_VAR=http://dev.myendpoint.com && npm run start:dev` or simply drop a `.env` file in the root that contains your key-value pairs like below: |
| 96 | + |
| 97 | +```sh |
| 98 | +ENV_1=http://1.myendpoint.com |
| 99 | +ENV_2=http://2.myendpoint.com |
| 100 | +``` |
| 101 | + |
| 102 | + |
| 103 | +With that in place, you can use the values in your code like `console.log(process.env.ENV_1);` |
0 commit comments