Skip to content

Latest commit

 

History

History
125 lines (77 loc) · 6.49 KB

README.md

File metadata and controls

125 lines (77 loc) · 6.49 KB
Raw

Lightning Web Components Recipes

CircleCI codecov

recipes-logo

A collection of easy-to-digest code examples for Lightning Web Components. Each recipe demonstrates how to code a specific task in 30 lines of code or less. A View Source link takes you right to the code in GitHub. From Hello World to data access and third-party libraries, there is a recipe for that!

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.

Installation Instructions

There are two ways to install Lightning Web Components Recipes:

  • 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 Recipes 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
  1. 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
  1. Clone the lwc-recipes repository:
git clone https://github.com/trailheadapps/lwc-recipes
cd lwc-recipes
  1. Create a scratch org and provide it with an alias (lwc-recipes in the command below):
sfdx force:org:create -s -f config/project-scratch-def.json -a lwc-recipes
  1. Push the app to your scratch org:
sfdx force:source:push
  1. Assign the recipes permission set to the default user:
sfdx force:user:permset:assign -n recipes
  1. Load sample data:
sfdx force:data:tree:import --plan ./data/data-plan.json
  1. Open the scratch org:
sfdx force:org:open

  1. In Setup, under Themes and Branding, activate the Recipes Lite or Recipes Blue theme.

  2. In App Launcher, select the LWC app.

Installing Recipes using an Unlocked Package

  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 Recipes unlocked package in your DE org.

  4. Select Install for All Users

  5. Import Account and Contacts data:

  • Click here to acccess the Accounts-Contacts.csv file. Right click in the browser window and save the file as Accounts-Contacts.csv.
  • In Setup, type Data Import in the Quick Find box and click Data Import Wizard.
  • Click Launch Wizard.
  • Click Accounts and Contacts, and click Add New Records.
  • Drag the Accounts-Contacts.csv file you just saved to the upload area.
  • Click Next, Next, and Start Import.

  1. In Setup, under Themes and Branding, activate the Recipes Lite or Recipes Blue theme.

  2. In App Launcher, select the LWC 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 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.)

Note: This projects also contains Jest tests for unit testing Lightning Web Components. If you experience errors regarding deasync when running npm install please check out the troubleshooting information in the lwc-jest repository.

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