Pattern Library

Copyright © 2017 - The University of Melbourne

The contents of this repository have been produced by The University of Melbourne for internal use and must not be distributed without the express permission of The University of Melbourne.

• Development Preview (Netlify deploy from dev branch)
• Production (Netlify deploy from master branch)

Getting started

The design system requires:

• Node (>=v22.17.0)
• Yarn (latest version)

# 1. Clone the repository.
git clone https://github.com/unimelb/pattern-lib.git

# 2. Enter your newly-cloned folder.
cd pattern-lib

# 3. Copy the env file.
cp .env.example .env

# 4. Copy the git pre-push hook
cp pre-push.sh .git/hooks/pre-push

# 5. Install dependencies. Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install
yarn

# 6. Start the Storybook development environment.
yarn dev

Developer documentation

• How to use the library - how this library externally
• Documenting stories - how to document the component in Storybook
• Icons - how to add new icons, and how to use icons in CSS and Vue components
• Contributing - how to get involved and contribute code
• Testing - how to test your changes to the design system
• Deployment - for developers, how to deploy new versions of the design system

Example websites

• The following UoM websites are using these components on the new Squiz CMS (Gen 2). Documentation on how to use these components in Edit+ Gen 2 documentation
• Study
• About Us
• Brand Hub