GOV.AU UI-Kit Starter Pack

Get quickly running with all uikit modules and some great npm scripts

Contents

• Install
• Requirements
• Contributing
• License

---

Install

To get the Starter Kit to work download this repo and run yarn or npm install to install all dependencies.

After you got all dependencies installed run yarn watch or npm run watch to spin up a new local server and watch for changed on *.scss files. Changes will be injected into your browser so you don’t even need to refresh thanks to Browser Sync.

⬆ back to top

---

Requirements

❗️The Starter Kit watch only works with Mac. If you must run Windows run npm run build after each change to your Sass.

⬆ back to top

---

Contributing

To contribute to the GOV.AU UI-Kit Starter Pack:

1. Fork the project & clone it locally.
2. Create a new branch for the work that is going to be completed.
3. Complete the work and test it to the best of your abilities following the guidelines here.
4. Once the work is completed, write a good commit message.
5. Push your work to github and create a new pull request.
6. Respond to any code review feedback.

⬆ back to top

---

License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};