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.

Contributing

Quick Start

If your development environment is setup simply run the following line in your terminal.

npm run ci && npm run storybook

It will install dependancies, build and deploy both Storybook HTML (http://localhost:6006/) and Storybook REACT (http://localhost:6007).

Otherwise see the full Setup instructions.

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 Quality and Testing Guide
• Code standards and style [MOVE TO STORYBOOK]
• Access requests
• Commit workflow [TODO]
• Staff training [TODO]
• Accessibility requirements [TODO]
• Testing
  • [FUTURE] Accessibility testing
  • Visual Regression Testing
• Package docs
  • icons
  • uqds-builder
  • storybook-html
• [FUTURE] Release management
  • Publishing Storybook
  • Publishing packages
• [FUTURE] CI/CD