UQ Design System (UQDS)

This is the repository for the UQ Design System.

The UQ Design System is a guide to how user interfaces should look, feel, behave and be coded at UQ. It includes a guide to the core styles, components, patterns and standards for UQ user interfaces.

Go to the UQ Design System website for information about:

• what the design system is
• how to use it
• UQ styles, components, patterns and examples
• how to contribute.

GitHub documentation

This contains information only relevent to working in the repository. Documentation about designing and developing user interfaces is on the UQ Design System website.

Contents:

• Setup instructions
• Using Storybook as a styleguide for component development
• Creating a new package
• Bundling
• Code standards and style [MOVE TO STORYBOOK]
• Access requests
• Commit workflow [TODO]
• Staff training [TODO]
• Accessibility requirements [TODO]
• Package docs
  • icons
  • uqds-builder
  • storybook-html
• [FUTURE] Accessibility testing
• [FUTURE] Visual unit/regression testing
• [FUTURE] Release management
  • Publishing Storybook
  • Publishing packages
• [FUTURE] CI/CD