tony534 / gps-design-systems-lwc

Salesforce LWCs for Australian Governments' Design Systems

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gps-design-systems-lwc

CI Workflow Packaging Workflow codecov

A collection of Salesforce Lightning Web Components (LWCs) for selected Governments' Design Systems. The collection covers Salesforce Experience Cloud as well as Salesforce Communities for Public Sector Solutions (Omnistudio), and may be extended in the future to help with Salesforce Flows provided they're surfaced via an Experience Cloud community.

Note that at this stage there is a dependency on Omnistudio 242.

Structure

  • sfGpsDs is the folder for code that is reusable across individual design systems supported by this repo and sfdx project; it must be installed as a first step.
  • sfGpsDsAuNsw is the folder for code and assets pertaining to the Design System of New South Wales, Australia; check the documentation web site
  • sfGpsDsAuNswS is the folder for code and assets pertaining to the specific Design System of Service NSW, New South Wales, Australia; check the documentation website
  • sfGpsDsAuVic is the folder for code and assets to the Design System of Victoria, Australia (pilot, no production without prior consultation); check the documentation website
  • sfGpsDsUkGov is the folder for code and assets to the Design System of the United Kingdom (early alpha, no production)

Installing beta versions using Unlocked Packages

Follow this set of instructions if you want to deploy the library in its most recent build to a more permanent environment than a Scratch org or if you don't want to install the local developement tools. You can use a non source-tracked orgs such as a free Developer Edition Org or a Trailhead Playground, or one of your sandboxes.

  1. Log in to your org

  2. Click this link to install the sfGpsDs unlocked package in your org.

  3. Click this link to install the sfGpsDsAuNsw unlocked package in your org.

  4. Click this link to install the sfGpsDsAuNswS unlocked package in your org.

  5. Click this link to install the sfGpsDsAuVic unlocked package in your org.

  6. Click this link to install the sfGpsDsUkGov unlocked package in your org.

Installing the production versions using Unlocked Packages

Kindly note that the packages might be the same as for non-production orgs (see above) if the latest successful build has alreay been promoted for production.

Make sure you fully understand the support and security implications of installing those assets in production. The applicable license has also wide-ranging disclaimer provisions.

  1. Log in to your org

  2. Click this link to install the sfGpsDs unlocked package in your production org (v1.5.0.7 on 17/04/2023).

  3. Click this link to install the sfGpsDsAuNsw unlocked package in your production org (v1.5.0.7 on 17/04/2023).

  4. Click this link to install the sfGpsDsAuNswS unlocked package in your production org (v1.5.0.1 on 06/04/2023).

  5. Click this link to install the sfGpsDsAuVic unlocked package in your production org (v1.5.0.2 on 06/04/2023). Please do let us know when doing so for non-educational use as we aim at supporting early adopters and gathering feedback.

Support, security, contributions and code of conduct

Do read our other guidelines:

About

Salesforce LWCs for Australian Governments' Design Systems

License:Creative Commons Zero v1.0 Universal


Languages

Language:CSS 34.7%Language:JavaScript 34.3%Language:HTML 18.4%Language:SCSS 10.6%Language:Apex 2.1%Language:Shell 0.0%