augustyakaravat/purealoe-lwc

Sample application for Lightning Web Components. Part of the sample gallery. Agriculture and retail use case. Get inspired and learn best practices.

Pure Aloe Lightning Web Components Sample Application

IMPORTANT: This is the new Lightning Web Components version of the Pure Aloe sample application. If you are looking for the Aura version, click here.

Pure Aloe is a fictional agricultural and manufacturing company that grows aloe and produces soaps and lotions for distributors and consumers. This app helps manage crops and harvests, as well as product distribution. Platform Events are used to update external distributor systems about stock, and publish updates from those systems in Salesforce.

Find more details about Pure Aloe on the Salesforce Developer blog:

Pure Aloe Sample App Part 1: Lightning Components & Salesforce DX

Pure Aloe Sample App Part 2: Integration with Platform Events

Spring 18 for Developers: Go With the Flow Like Never Before

Table of Contents

• Installation

  • Installing Pure Aloe using a scratch org
  • Installing Pure Aloe using an unlocked package

• Optional installation instructions

• Distributor App

Installation

There are two ways to install Pure Aloe:

• Using a Scratch Org: This is the recommended installation option. Use this option if you are a developer who wants to experience the app and the code.
• Using an Unlocked Package: This option allows anybody to experience the sample app without installing a local development environment.

Installing Pure Aloe 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, authenticate with your hub org and provide it with an alias (myhuborg in the command below):

sfdx force:auth:web:login -d -a myhuborg

3. Clone the purealoe repository:

git clone https://github.com/trailheadapps/purealoe-lwc
cd purealoe-lwc

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

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

5. Push the app to your scratch org:

sfdx force:source:push

6. Assign the purealoe permission set to the default user:

sfdx force:user:permset:assign -n purealoe

7. Load sample data:

sfdx force:data:tree:import --plan ./data/Harvest_Field__c-plan.json
sfdx force:data:tree:import --plan ./data/Merchandise__c-plan.json

8. Open the scratch org:

sfdx force:org:open

9. In App Launcher, select the Pure Aloe app

10. Have fun exploring!

Installing Pure Aloe using an unlocked package

Use this option if you don't have the Salesforce CLI configured or if you want to experience the sample app and do not plan to modify the code.

1. Sign up for a Developer Edition (DE) org.

2. Enable MyDomain in your DE org. Instructions to do this are here.

3. Click this link to install the Pure Aloe unlocked package into your DE org. Approve the Third-Party access during the installation process.

4. Select Install for All Users

5. Import Harvest Field data:

• In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
• Click Launch Wizard.
• Click the Custom objects tab, click Harvest Fields, and click Add new records.
• Drag Harvest_Field_Data.csv from the data folder of this project to the upload area.
• Click Next, Next, and Start Import.

6. Import Merchandise data:

• In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
• Click Launch Wizard.
• Click the Custom objects tab, click Merchandises, and click Add new records.
• Drag Merchandise_Data.csv from the data folder of this project to the upload area.
• Click Next, Next, and Start Import.

7. In App Launcher, select the PureAloe app

8. Have fun exploring!

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 Lighning 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

Distributor App

To explore how Pure Aloe uses Platform Events to integrate with external systems, download and configure the Pure Aloe distributor app.

When you create a Product Bundle in Salesforce and change its status to Submitted to Distributors, the Bundle Submitted process automatically publishes the Bundle_Submitted__e platform event. The distributor app is listening for that event and automatically adds the product bundle to the bundle list when a Bundle_Submitted__e event comes in.

When you click the Order button next to a bundle in the distributor app, the distributor app publishes a Bundle_Ordered__e event. The Bundle Ordered process (in Process Builder) listens for that event and automatically changes the order status to Ordered by Distributor when an event comes in. If a user is looking at the record details page for that bundle, the status will automatically change (no page refresh required) because the status path component is using the Streaming API to listen for status changes. For this last part to work, you need to execute the following Salesforce DX command to create the Streaming API topic:

sfdx force:apex:execute -f ./apex/createPushTopic.apex

Take a look at the createPushTopic.apex file in the /apex folder to examine the push topic creation logic.

Note that you could also have listened directly for the platform event in the status path component and update the status to Ordered by Distributor in the UI when the event comes in. However, that approach could lead to inconsistencies in case the server-side status update (handled by the Bundle Ordered process) fails, because a validation rule is not met for example. In that case the UI would show the status as Ordered by Distributor, while the status in the database would still be Submitted to Distributor.