Definition
In Salesforce DX development, a project directory on a developer's local machine that contains the sfdx-project.json configuration file, source code, metadata, and scripts for working with a scratch org or sandbox.
Real-World Example
When the IT director at Vertex Global needs to streamline operations, they turn to Local Project to scale their operations using the Salesforce platform. Local Project gives them the infrastructure and tools needed to support new business requirements, handle increased data volumes, and serve a growing user base without compromising performance.
Why Local Project Matters
In Salesforce DX development, a Local Project is a project directory on a developer's local machine that contains the sfdx-project.json configuration file, source code, metadata, and scripts for working with a Scratch Org or Sandbox. The local project structure follows Salesforce DX conventions, with metadata organized into directories and files that can be tracked in Git for version control and collaboration.
Local projects are foundational to source-driven development with Salesforce DX. Developers clone the project from Git, create a Scratch Org through the Salesforce CLI, push source from the local project to the Scratch Org, work on changes, pull updates back to the local project, and commit changes to Git. This workflow makes Salesforce development feel like modern web development with Git, branches, and code review. Mature Salesforce teams using DX organize their work entirely around local projects and Git.
How Organizations Use Local Project
- •Quantum Labs — All developers work in local projects cloned from Git, using Scratch Orgs as their sandbox and the CLI to push and pull source.
- •TerraForm Tech — Maintains their entire Salesforce metadata in a Git repository as local projects, treating Salesforce code like any other software project.
- •CodeBridge — Builds CI/CD pipelines around local projects, automatically deploying from Git branches to test orgs.