{"id":14037168,"url":"https://github.com/govau/design-system-starter","last_synced_at":"2025-07-27T05:30:32.266Z","repository":{"id":48023324,"uuid":"91524100","full_name":"govau/design-system-starter","owner":"govau","description":"🚀 The Australian Government Design System - Starter","archived":true,"fork":false,"pushed_at":"2021-08-19T23:54:05.000Z","size":5859,"stargazers_count":69,"open_issues_count":13,"forks_count":29,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-08-13T03:07:11.625Z","etag":null,"topics":["auds","australia","components","design-systems","government","pattern-library","starter-kit","starter-project"],"latest_commit_sha":null,"homepage":"https://design-system-starter.apps.b.cld.gov.au/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/govau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-17T02:17:34.000Z","updated_at":"2024-07-27T19:49:17.000Z","dependencies_parsed_at":"2022-07-28T20:19:55.379Z","dependency_job_id":null,"html_url":"https://github.com/govau/design-system-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/govau%2Fdesign-system-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/govau%2Fdesign-system-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/govau%2Fdesign-system-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/govau%2Fdesign-system-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/govau","download_url":"https://codeload.github.com/govau/design-system-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227762557,"owners_count":17816038,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auds","australia","components","design-systems","government","pattern-library","starter-kit","starter-project"],"created_at":"2024-08-12T03:02:32.970Z","updated_at":"2024-12-02T16:32:11.889Z","avatar_url":"https://github.com/govau.png","language":"SCSS","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"\u003e **The Australian Government Design System has been decommissioned [Visit our community page for more information](https://community.digital.gov.au/t/dta-design-system-has-been-decommissioned/4649)**\n\nAustralian Government Design System - Starter\n==========================\n\n\u003e Get started with full page templates using the Australian Government Design System.\n\n## Contents\n\n\n* [Templates](#templates)\n* [Development environment](#development-environment)\n* [Get started](#get-started)\n* [How it works](#how-it-works)\n* [Prerequisites](#prerequisites)\n* [Contributing](#contributing)\n* [License](#license)\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n\n## Templates\n\n\nBrowse full page templates using the Australian Government Design System.\n\n- [Home page](https://design-system-starter.apps.b.cld.gov.au/)\n- [Content page](https://design-system-starter.apps.b.cld.gov.au/content/)\n- [Form page](https://design-system-starter.apps.b.cld.gov.au/form/)\n\n\n## Development environment\n\nClone this repository to create a local development environment and start modifying the templates.\n\n* [Get started](#get-started)\n* [How it works](#how-it-works)\n* [Contributing](#contributing)\n* [License](#license)\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n\n## Get started\n\nThe starter pack uses npm (node package manager) to set up a local development environment and install the Design System components. The default package manager for Node is npm. When you download Node, npm comes pre-installed.\n\n1. Make sure you have npm and Node installed on your computer. You can follow the [npm instructions](https://www.npmjs.com/get-npm) if you are unsure.\n\n1. Download, clone, or fork this repository into a folder on your computer.\n\n1. In the command line go into this folder and run `npm install`. This will install dependencies necessary for the local development environment.\n\n1. You should now be ready to start your local server by running `npm run watch`. This will watch for changes on `*.scss` files, create new `*.css` files and refresh the browser.\n\n\n### Using Docker\n\nBuild the image:\n\n```bash\n$ docker build -t ds-starter .\n```\n\nThen run the image and map the volume. Note: $PWD is not supported in windows.\n\n```bash\n$ docker run --rm --volume=\"$PWD:/app\" -p 3000:3000 -it ds-starter\n```\n\n**[⬆ back to top](#contents)**\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n\n## How it works\n\nIn your directory you have a `package.json` file. This file points to dependencies to install when running `npm install`. When you run `npm install` you install all of the Design System components and additional packages related to the local development environment.\n\nAfter `npm install` [Pancake](https://github.com/govau/pancake) is ran, this checks that your dependencies work together and creates the `docs/js/script.min.js` and `src/sass/_uikit.scss`.\n\nThe `src/sass/main.scss` imports the generated `_uikit.scss`. You shouldn't touch the `_uikit.scss` file as it is generated, but feel free to change the `main.scss` file. \n\nWhen the user runs `npm run build` or `npm run watch` we use [node-sass](\"https://www.npmjs.com/package/node-sass?activeTab=versions\") to convert the `src/sass/main.scss` file into the `docs/css/main.css` file. [Autoprefixer](\"https://www.npmjs.com/package/autoprefixer\") is ran after compilation to add vendor prefixes to the `main.css` file.\n\n\u003e Refer to the `package.json` scripts for how this has been set up\n\nThis set up allows you to modify the variables in the Design System file from the `main.scss` file. You can add your own colour scheme, or change the typography and spacing. Tweaks to the components or additional ones should be added below the import of `_uikit.scss`. Changes to these files will be injected into your browser so you don’t even need to refresh thanks to [Browser Sync](https://www.browsersync.io/).\n\nThe `docs` folder in the contains all the files required to publish a website. The `index.html` file references the `main.css` file and `script.min.js` assets to generate the page. We name the folder `docs` because [github pages](https://pages.github.com/) uses the docs folder to host static websites. \n\n\n**[⬆ back to top](#contents)**\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n## Prerequisites\n- [`Node.js`](https://nodejs.org) **8 or higher**, preferably the current LTS version.\n\n\u003e **NOTE:** If you're developing on Windows, please ensure that [your local `npm` configuration is using a shell that supports UNIX like folder pathing](https://stackoverflow.com/questions/23243353/how-to-set-shell-for-npm-run-scripts-in-windows) ( i.e `a/unix/path`  rather than `a\\\\windows\\\\path` ).\n\n**[⬆ back to top](#contents)**\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n\n## Contributing\n\nTo contribute to the Australian Government Design System Starter Pack:\n1. Fork the project \u0026 clone it locally.\n1. Create a new branch for the work that is going to be completed.\n1. Complete the work and test it to the best of your abilities following the [guidelines here](https://github.com/govau/uikit#checklist-and-browser-support).\n1. Once the work is completed, write a good commit message.\n1. Push your work to GitHub and create a new pull request.\n1. Respond to any code review feedback.\n\n\n**[⬆ back to top](#contents)**\n\n\n----------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n\n## License\n\nCopyright (c) Commonwealth of Australia. With the exception of the Commonwealth Coat of Arms and where otherwise noted, this work is licensed under the [MIT license](https://raw.githubusercontent.com/govau/design-system-starter/master/LICENSE).\n\n\n**[⬆ back to top](#contents)**\n\n# };\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgovau%2Fdesign-system-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgovau%2Fdesign-system-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgovau%2Fdesign-system-starter/lists"}