The Agriculture Design System (AgDS) is a new design system for the Department of Agriculture, Fisheries and Forestry. AgDS is a suite of tools and guidelines to help designers and developers build the steel threads of the Export Service with efficiency and consistency.
If you are starting a new project, you should clone the starter kit.
If you are looking to implement AgDS components, you need to install packages from NPM.
You should only clone this repo if you are looking to contribute to it, such as…
- Improving documentation
- Updating existing components
- Creating new components for consideration and feedback
Important
Do not use agency data when working in any Github repository.
To run the dev and builds in this repository you will need version 18.18.2 of Node.js installed
and the yarn (v1) package manager.
We recommend using nvm to manage node versions: https://github.com/nvm-sh/nvm
- Clone the repo to your local machine
cdinto the repo and runyarnto install and link dependencies.
For development run one or more of the following commands:
yarn docs:dev– start the docs siteyarn storybook:dev– start storybookyarn playroom:dev– start playroomyarn example:dev– start the example siteyarn yourgov:dev– start the example form site
We use the develop branch as an integration branch for features and the main branch as the official release branch. When creating new branches, always branch from develop.
git checkout develop
git checkout -b my-feature-branchDeployment of the website is handled by github actions. The site is deployed automatically anytime changes are merged to the main branch.
You can run the builds locally for testing. The order of commands here is important. Because storybook, playroom, the example site and example form site is being bundled into the docs site public folder, they all must be built before the docs site.
yarn storybook:build
yarn playroom:build
yarn example:build
yarn yourgov:build
yarn docs:buildNOTE: If you see an error during the build like the following:
> Build error occurred Error: ENOENT: no such file or directory, open '.../packages/logo/package.json'Check if the package has been removed or renamed. If so you may need to delete the folder.