This project is a modern starter for enterprise apps using:
- PatternFly (v6 prerelease, React 19 compatible)
- Vite (for fast dev/build)
- TypeScript
- React 19
This project supports vibe coding workflows, where you can direct an AI agent to use the ai-documentation/ directory as a primary source for developing with PatternFly. The documentation in this directory provides:
- Core rules and best practices for PatternFly React development
- Component usage guidelines, layout rules, and troubleshooting
- Quick navigation to specialized rules and resources
Tip: When using an AI coding assistant (like Cursor), you can instruct it to prioritize the ai-documentation directory for authoritative guidance on PatternFly usage in this codebase.
If you are using the Cursor editor, there is a Cursor rule you can leverage to further enhance AI-driven development. This rule helps the agent understand how to use the ai-documentation directory as the primary source for PatternFly-related questions and implementation details.
- Uses Jest and React Testing Library for unit tests.
- CSS and SVG imports are mocked using
identity-obj-proxyand a custom SVG mock. - Test files are colocated with their components in the same directory.
- See
jest.config.cjsfor configuration details.
- Each page (Dashboard, Settings, Instances, Documentation) is in its own directory under
src/pages/, with its test and anindex.tsxre-export. - Main navigation and layout are managed in
App.tsxusing PatternFly'sPage,Masthead, andSidebarcomponents.
npm testnpm run devThis project demonstrates best practices for building maintainable, accessible, and enterprise-ready UIs with PatternFly, Vite, TypeScript, and React 19.