E-Bikes Lightning Web Components Sample Application

E-Bikes is a sample application that demonstrates how to build applications with Lightning Web Components and integrate with Salesforce Communities. E-Bikes is a fictitious electric bicycle manufacturer. The application helps E-Bikes manage their products and reseller orders using a rich user experience.

This sample application is designed to run on Salesforce Platform. If you want to experience Lightning Web Components on any platform, please visit https://lwc.dev, and try out our Lightning Web Components sample application LWC Recipes OSS.

Table of contents

• Installing E-Bikes using a scratch org

• Installing E-Bikes using a Developer Edition Org or a Trailhead Playground

• Optional installation instructions

• Salesforce Application Walkthrough

• Communities Application Walkthrough

Installing E-Bikes 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 repository:

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

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

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

5. Push the app to your scratch org:

   sfdx force:source:push
   

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

   sfdx force:user:permset:assign -n ebikes
   

7. Import sample data:

   sfdx force:data:tree:import -p ./data/sample-data-plan.json
   

8. Deploy Community metadata:

   sfdx force:mdapi:deploy -d mdapiDeploy/unpackaged -w 5
   

9. Publish the Community:

   sfdx force:community:publish -n E-Bikes
   

10. Open the scratch org:

    sfdx force:org:open
    

11. In Setup, under Themes and Branding, activate the Lightning Lite theme.

12. Open the App Launcher, click View All then click on either of the E-Bikes cards to open the app or the Community.

Installing E-Bikes 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.

Make sure to start from a brand-new environment to avoid conflicts with previous work you may have done.

1. Log in to your org
2. If you are setting up a Developer Edition: go to Setup, under My Domain, register a My Domain.

Step 1: Enable and Configure Communities

Enable Communities by following these steps:

1. In your org, navigate to Setup, enter communities in the Quick Find box then select Communities Settings.
2. Click the Enable communities checkbox
3. Enter a domain name for your community. Remember this value as you’ll use it later in this step.
4. Make sure that your domain name is available by clicking Check Availability.
5. Click Save then Ok.
6. Navigate back to Communities Settings in Setup.
7. Under Community Management Settings, click the Enable ExperienceBundle Metadata API checkbox, and click Save.

Configure the Communities metadata file:

1. Edit the force-app/main/default/sites/E_Bikes.site-meta.xml file.
2. Replace the value between the <siteAdmin> tags with your Playground username.
3. Replace the value between the <siteGuestRecordDefaultOwner> tags with your Playground username.
4. Replace the value between the <subdomain> tags with your Communities domain.
5. Save the file.

Step 2: Prepare the Org's Metadata

Remove the Product custom field from the Case object:

1. In Setup, click the Object Manager tab.
2. Click on the Case object.
3. Click Fields & Relationships.
4. Locate the Product picklist field and click Delete from the row menu.
5. Confirm deletion by clicking Delete.

Step 3: Deploy the App

Deploy the app to your org with the Salesforce CLI:

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

   sfdx force:source:deploy -p force-app
   

2. Assign the ebikes permission set to the default user.

   sfdx force:user:permset:assign -n ebikes
   

3. Import some sample data.

   sfdx force:data:tree:import -p ./data/sample-data-plan.json
   

4. Deploy the Community metadata.

   sfdx force:mdapi:deploy -d mdapiDeploy/unpackaged -w 5
   

5. Publish the Community.

   sfdx force:community:publish -n E-Bikes
   

6. In your org, navigate to Setup, enter themes in the Quick Find box then select Themes and Branding.

7. Locate the Lightning Lite theme and click Activate from the row menu.

Congratulations! You’ve successfully set up the E-Bikes sample app. Open the App Launcher, click View All then click on either of the E-Bikes cards to open the app or the Community.

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

Salesforce Application Walkthrough

Product Explorer

1. Click the Product Explorer tab.

2. Filter the list using the filter component in the left sidebar.

3. Click a product in the tile list to see the details in the product card.

4. Click the expand icon in the product card to navigate to the product record page.

Product Record Page

1. The product record page features a Similar Products component.

2. Click the View Details button to navigate to a similar product record page.

Reseller Orders

1. Click the down arrow on the Reseller Order tab and click New Reseller Order.

2. Select an account, for example Wheelworks and click Save.

3. Drag a product from the product list on the right onto the gray panel in the center. The product is automatically added to the order as an order item.

4. Modify the ordered quantity for small (S), medium (M), and large (L) frames and click the save button (checkmark icon).

5. Repeat steps 3 and 4 to add more products to the order.

6. Mouse over an order item tile and click the trash can icon to delete an order item from the order.

Account Record Page

The account record page features an Account Map component that locates the account on a map.

Communities Application Walkthrough

Home

1. See the custom hero component in Communities that pulls in rich assets and navigates to the product or product family that is configured.

2. Check all the properties exposed in the hero component in Community Builder.

Create Case

1. Select the My Cases list view in the record list on the right side of the page.

2. Fill in the details of the case on the left side of the page.

3. Click on Create Case and see the record list to be updated with your new case.

Product Explorer

1. Click the Product Explorer tab.

2. Filter the list using the filter component in the left sidebar.

3. Click a product in the tile list to see the details in the product card.

4. Click the expand icon in the product card to navigate to the product record page.

Product Record Page

1. The product record page features a Similar Products component.

2. Click the View Details button to navigate to a similar product record page.