CC0-1.0 License
E-Bikes is a sample application that demonstrates how to build applications with Lightning Web Components and integrate with Salesforce Experiences. 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.
Set up your environment. Follow the steps in the Quick Start: Lightning Web Components Trailhead project. The steps include:
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
Clone the repository:
git clone https://github.com/trailheadapps/ebikes-lwc
cd ebikes-lwc
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
Push the app to your scratch org:
sfdx force:source:push
Assign the ebikes permission set to the default user:
sfdx force:user:permset:assign -n ebikes
Assign the Walkthroughs permission set to the default user:
sfdx force:user:permset:assign -n Walkthroughs
Import sample data:
sfdx force:data:tree:import -p ./data/sample-data-plan.json
Publish the Experience Cloud site:
sfdx force:community:publish -n E-Bikes
Deploy metadata for the Experience Cloud guest user profile:
sfdx force:mdapi:deploy -d guest-profile-metadata -w 10
Open the scratch org:
sfdx force:org:open
In Setup, under Themes and Branding, activate the Lightning Lite theme.
In App Launcher, select the E-Bikes app.
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.
Clone this repository:
git clone https://github.com/trailheadapps/ebikes-lwc
cd ebikes-lwc
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
Enable Experiences with the following steps:
Configure the Experience Cloud site metadata file with the following steps:
force-app/main/default/sites/E_Bikes.site-meta.xml
file.<siteAdmin>
tags with your Playground username.<siteGuestRecordDefaultOwner>
tags with your Playground username.<subdomain>
tags with your domain.Remove the Product
custom field from the Case
object with the following steps:
Deploy the App with these steps:
Run this command in a terminal to deploy the app.
sfdx force:source:deploy -p force-app
Assign the ebikes permission set to the default user.
sfdx force:user:permset:assign -n ebikes
Import some sample data.
sfdx force:data:tree:import -p ./data/sample-data-plan.json
Publish the Experience Cloud site.
sfdx force:community:publish -n E-Bikes
Deploy metadata for the Experience Cloud guest user profile:
sfdx force:mdapi:deploy -d guest-profile-metadata -w 10
If your org isn't already open, open it now:
sfdx force:org:open
In Setup, under Themes and Branding, activate the Lightning Lite theme.
In App Launcher, select the E-Bikes app.
After installing the E-Bikes Salesforce app, you can install an optional ebikes-manufacturing demo app. This demo is built with the Lightning Web Runtime and demonstrates the use of the Pub Sub API with Change Data Capture events and Platform Events.
This repository contains several tools and scripts 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.
To benefit from these developer tools, you must:
npm install
in a terminal.For reference, the full list scripts and dependencies and can be found in package.json.
Prettier is a code formatter used to ensure consistent formatting across your code base. The .prettierignore and .prettierrc files provided as part of this repository control the behavior of the Prettier formatter.
To run Prettier from the command line, run npm run prettier
.
To use Prettier with Visual Studio Code, install this extension from the Visual Studio Code Marketplace.
ESLint is a popular JavaScript linting tool used to identify stylistic errors and erroneous constructs. 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.
To run ESLint from the command line, run npm run lint
.
To use ESLint with Visual Studio Code, install this extension from the Visual Studio Code Marketplace. The extension provides a code overlay that help you identify linting issues quickly.
We use Husky and lint-staged to set up a pre-commit hook that enforces code formatting and linting by running Prettier and ESLint every time you git commit
changes.
Prettier and ESLint will automatically run every time you commit changes. The commit will fail if linting errors are detected in your changes.
Jest is the testing library that we use to test our Lightning web components. More precisely, we use a Jest wrapper library to run LWC tests. These tests are run on your local machine or in CI, not in Salesforce.
To run LWC tests from the command line, run npm test
.
We use UTAM with WebdriverIO to run UI tests on our app. Read this blog post for a quick overview of this technology.
We run end-to-end tests on the Product Explorer page with force-app/test/utam/page-explorer.spec.js
.
Follow these steps to run the UI tests manually:
sfdx force:org:open
npm run test:ui:compile
npm run test:ui:generate:login
npm run test:ui
Note: if the test runner fails to open Chrome programmatically, update the chromedriver
dependency to the latest version in package.json
then, run npm install
and npm run test:ui
again.
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.