Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Enable Dev Hub Features in Your Org
Project Setup
Sample Repository on GitHub
Create a Salesforce DX Project
Salesforce DX Project Structure and Source Format
How to Exclude Source When Syncing or Converting
Create a Salesforce DX Project from Existing Source
Retrieve Source from an Existing Managed Package
Retrieve Unpackaged Source Defined in a package.xml File
Convert the Metadata Source to Source Format
Salesforce DX Usernames and Orgs
Override or Add Definition File Options at the Command Line
Link a Namespace to a Dev Hub Org
Salesforce DX Project Configuration
Multiple Package Directories
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Development
Build and Release Your App
First-Generation Managed Packages
Second-Generation Managed Packages
Unlocked Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Sample Repository on GitHub

If you want to check out Salesforce DX features quickly, start with the dreamhouse-lwc GitHub repo. This standalone application contains an example of the project configuration file (sfdx-project.json), multiple Apex classes, Aura components, Visualforce components, custom objects, sample data, and Apex tests.

Cloning this repo creates the directory dreamhouse-lwc. See the repo’s Readme for more information.

Assuming that you’ve already set up Git, use the git clone command to clone the master branch of the repo from the command line.

To use HTTPS:

1git clone https://github.com/trailheadapps/dreamhouse-lwc.git

To use SSH:

1git clone git@github.com:trailheadapps/dreamhouse-lwc.git

If you don’t want to use Git, download a .zip file of the repository’s source using Clone, or download on the GitHub website. Unpack the source anywhere on your local file system.

Check out more complex examples in the Sample Gallery.

It contains sample apps that show what you can build on the Salesforce platform. They’re continuously updated to incorporate the latest features and best practices.

Tip