Skip to content

Latest commit

 

History

History
216 lines (140 loc) · 8.87 KB

README.md

File metadata and controls

216 lines (140 loc) · 8.87 KB
Raw

E-Bikes Lightning Web Components Sample Application

CI Workflow codecov

ebikes-logo

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.

Trailhead Badge Learn more about this app by completing the Quick Start: Explore the E-Bikes Sample App Trailhead project.


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

  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 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. Assign the Walkthroughs permission set to the default user:

    sfdx force:user:permset:assign -n Walkthroughs

  8. Import sample data:

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

  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. In App Launcher, select the E-Bikes app.

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. Clone this repository:

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

  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. Enable Experiences with the following steps:

    1. In your org, in Setup, select Settings, under Digital Experiences.
    2. Click the Enable Digital Experiences checkbox
    3. Enter a domain name for your experience site. 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 Settings in Setup.
    7. Under Experience Management Settings, enable Enable ExperienceBundle Metadata API.

  4. Configure the Community metadata file with the following steps:

    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 domain.
    5. Save the file.

  5. Remove the Product custom field from the Case object with the following steps:

    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.

  6. Start an In-App Guidance trial

    1. In Setup, navigate to User Engagement > In-App Guidance.
    2. Click on the Start Walkthrough Trial.
    3. Click on Submit.

  7. Deploy the App with these steps:

    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. Publish the Community.

      sfdx force:community:publish -n E-Bikes

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

      sfdx force:org:open -u mydevorg

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

    7. In App Launcher, select the E-Bikes app.

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.