Automation Components

Automation Components provides a set of reusable and production-ready extensions that include invocable actions, flow screen components and local actions. These are intended as an easy to install, easy to use toolbox. Read more in this blog post.

Learn more about this app by completing the Quick Start: Explore the Automation Components Sample App Trailhead project.

This is an Open Source project. A special thanks to the project contributors.

Check out the community site unofficialsf.com for more Automation developer resources.

Table of contents

• 📖 Automation Components Reference

• Installing the components using Managed Packages: This is the recommended installation option. This option allows anybody to experience the components without installing a local development environment.

• Installing the components using a Scratch Org: Use this option if you are a developer who wants to experience the components and the code.

• Installing the components using a Developer Edition Org or a Trailhead Playground: Useful when tackling Trailhead Badges or if you want the components deployed to a more permanent environment than a Scratch org.

• Optional installation instructions

• Code tours

Installing the components using Managed Packages

Follow this set of instructions if you want to deploy the components to your production org or to a development environment that's more permanent than a Scratch org. You can use a non source-tracked orgs such as a free Developer Edition Org, a Trailhead Playground or a production org.

1. Log in to your org

2. Click links from the table to install the managed packages in your org.

   Disclaimer: these packages haven't gone through security review yet but that is our plan for the future.

Installing the components using a Scratch Org

1. Set up your environment. Follow the steps in the Quick Start: Lightning Web Components Trailhead project. The steps include:

   • Enable Dev Hub in your Trailhead Playground
   • Install Salesforce CLI
   • Install Visual Studio Code
   • Install the Visual Studio Code Salesforce extensions, including the Lightning Web Components extension

2. If you haven't already done so, authorize your hub org and provide it with an alias (myhuborg in the command below):

   sfdx auth:web:login -d -a myhuborg
   

3. Clone this repository:

   git clone https://github.com/trailheadapps/automation-components
   cd automation-components
   

4. Create a scratch org and provide it with an alias (automation in the command below):

   sfdx force:org:create -s -f config/project-scratch-def.json -c -a automation
   

5. Push the app to your scratch org:

   sfdx force:source:push
   

6. Open the scratch org:

   sfdx force:org:open
   

Installing the components using a Developer Edition Org or a Trailhead Playground

Follow this set of instructions if you want to deploy the app to a more permanent environment than a Scratch org. This includes non source-tracked orgs such as a free Developer Edition Org or a Trailhead Playground.

1. Clone this repository:

   git clone https://github.com/trailheadapps/automation-components
   cd automation-components
   

2. Authorize your Trailhead Playground or Developer org and provide it with an alias (mydevorg in the command below):

   sfdx auth:web:login -s -a mydevorg
   

3. Run this command in a terminal to deploy the app.

   sfdx force:source:deploy -p src-collections,src-data,src-flows,src-messaging,src-security,src-strings,src-ui,src-utilities
   

4. If your org isn't already open, open it now:

   sfdx force:org:open -u mydevorg
   

Optional Installation Instructions

This repository contains several files that are relevant if you want to integrate modern web development tooling to your Salesforce development processes, or to your continuous integration/continuous deployment processes.

Code formatting

Prettier is a code formatter used to ensure consistent formatting across your code base. To use Prettier with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .prettierignore and .prettierrc files are provided as part of this repository to control the behavior of the Prettier formatter.

Code linting

ESLint is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. To use ESLint with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The .eslintignore file is provided as part of this repository to exclude specific files from the linting process in the context of Lightning Web Components development.

Pre-commit hook

This repository also comes with a package.json file that makes it easy to set up a pre-commit hook that enforces code formatting and linting by running Prettier and ESLint every time you git commit changes.

To set up the formatting and linting pre-commit hook:

1. Install Node.js if you haven't already done so
2. Run npm install in your project's root folder to install the ESLint and Prettier modules (Note: Mac users should verify that Xcode command line tools are installed before running this command.)

Prettier and ESLint will now run automatically every time you commit changes. The commit will fail if linting errors are detected. You can also run the formatting and linting from the command line using the following commands (check out package.json for the full list):

npm run lint:lwc
npm run prettier

Code Tours

Code Tours are guided walkthroughs that will help you understand the app code better. To be able to run them, install the CodeTour VSCode extension.