This code is made available free, as part of the Salesforce Labs programme. Salesforce Labs is a programme that lets salesforce.com engineers, professional services staff & other employees share AppExchange apps they've created with the customer community. Inspired by employees' work with customers of all sizes and industries, these apps range from simple utilities to entire vertical solutions. Salesforce Labs apps are free to use, but are not official salesforce.com products, and should be considered community projects - these apps are not officially tested or documented. For help on any Salesforce Labs app please consult the Salesforce message boards - salesforce.com support is not available for these applications. Questions? Please visit https://success.salesforce.com/answers.
A repository of UK government GDS UI components in SFDX format
You will need the latest version of the sfdx cli (https://developer.salesforce.com/tools/sfdxcli) and a hub org configured. This repository is designed to be deployed to a Scratch Org. It is possible to create the sfdx components into org metadata and deploy using the sfdx cli to a non-scratch org. Please see the documentation for deploying metadata using sfdx (https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_mdapi.htm).
Please make sure you are running the latest version
sfdx update
Download or clone this repository to your local machine
If you want to build everything, simply run scripts/buildAll.sh
(making sure it is executable first)
- Open your terminal and navigate to the repositories base directory.
- Make sure the scripts are executable
chmod +x scripts/*.sh
- run
scripts/createScratchOrg.sh
- Wait for the scratch org to build
- run
scripts/createCommunities.sh
- Wait for the experience to build (you can run the command listed in the output of the previous command to check the status)
- It should take no longer than 1 min to create each of the experiences.
- The VisualForce experience is to demonstrate progressive enhancement and is therefore optional
- run
scripts/deploySource.sh
- Wait for the command to complete
- run
scripts/publishCommunities.sh
- Wait for the command to complete
- run
scripts/openOrg.sh
- The org will now open in your default browser window
- Goto Setup -> All Communities to see the GDS Demo Community
- The
publishCommunity.sh
script will return a URL wit the gdsdemo community full path in - The first part of this url is the community url that can be used to open the VisualForce landing community
- Replace gdsdemo with gdslanding in the url and paste to your browser URL bar
Note: Unauthenticated access to the experience is only supported in Spring '21 and greater.
If you would like the Juggling license application page to appear in the main header bar as a navigatable page option then you'll need to add the page to the default community menu.
To do this:
- Open the Experience Builder
- Open the Settings menu (Clog on theleft-hand side of the page)
- Select Navigation
- Click the down arrow menu on the right and select Edit
- Click Add Menu Item
- Name Juggling license
- Type Community Page
- Page Juggling license
- Check Public available
- Click Save Menu
in govMarkupText.js-meta.xml, please make sure for unmanaged component to change "uxgovuk-gov-markup-text-editor' to "c-gov-markup-text-editor"