Watch how to setup in Salesforce and see how it works here.
- Prerequisites
- Deployment Steps
- VS Code Deployment (Using Salesforce Extension Pack)
- Project Components
- Post-Deployment Configuration
- Troubleshooting
- Environment-Specific Deployments
- Best Practices
- Quick Deploy Script
- Support
- References
- Salesforce CLI (latest version)
npm install -g @salesforce/cli
- Node.js (version 18 or higher)
- Git (for version control)
- VS Code with Salesforce Extension Pack (recommended)
- Access to a Salesforce org (Production, Sandbox, or Developer Edition)
- System Administrator permissions
- API access enabled
sf --version
sf org login web --alias prodOrg
sf org login web --alias sandboxOrg --instance-url https://test.salesforce.com
sf org list
sf config set target-org prodOrg
Before deploying, validate your metadata:
sf project deploy validate --source-dir force-app
sf project deploy start --source-dir force-app
# Deploy only LWC components
sf project deploy start --source-dir force-app/main/default/lwc
# Deploy only static resources
sf project deploy start --source-dir force-app/main/default/staticresources
sf project deploy report
-
Install Salesforce Extension Pack:
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "Salesforce Extension Pack"
- Install the official extension by Salesforce
-
Open Project in VS Code:
code .
- Open Command Palette (
Ctrl+Shift+P
) - Type:
SFDX: Authorize an Org
- Select your org type:
- Production/Developer: Select "Production"
- Sandbox: Select "Sandbox"
- Enter org alias (e.g.,
vscodeOrg
) - Complete authentication in browser
- Command Palette (
Ctrl+Shift+P
) - Type:
SFDX: Set a Default Org
- Select your authorized org
Option A: Deploy Entire Project
- Right-click on
force-app
folder - Select
SFDX: Deploy Source to Org
Option B: Deploy Specific Components
- Right-click on specific file/folder (e.g.,
lwc/acdVoicemailViewer
) - Select
SFDX: Deploy Source to Org
Option C: Deploy from Explorer
- Select files in Explorer
- Right-click →
SFDX: Deploy Source to Org
- Check Output panel (View → Output)
- Select "Salesforce CLI" from dropdown
- Monitor deployment progress and results
Command | Shortcut | Description |
---|---|---|
SFDX: Deploy Source to Org |
- | Deploy selected metadata |
SFDX: Retrieve Source from Org |
- | Pull changes from org |
SFDX: Create Lightning Web Component |
- | Generate new LWC |
SFDX: Execute Anonymous Apex |
Ctrl+Shift+P |
Run Apex code |
SFDX: Open Default Org |
- | Open org in browser |
- Bottom-left corner shows current default org
- Click org name to switch between authorized orgs
- Green checkmark indicates successful connection
This project includes:
- Lightning Web Component:
acdVoicemailViewer
- Static Resource:
GenesysAuthCallback.html
- Metadata: Applications, layouts, permission sets, tabs, etc.
Navigate to Setup → Users → Permission Sets and assign relevant permissions to users.
- Go to App Launcher → ACD Voicemail (if application is included)
- Configure any custom settings or metadata
- Navigate to the Lightning App Builder
- Add the
acdVoicemailViewer
component to a page - Test functionality
No authorization information found for [orgAlias]
Solution: Re-authenticate using sf org login web --alias [orgAlias]
Check deployment status:
sf project deploy report --job-id [deployment-id]
Solution: Use --ignore-conflicts
flag (use with caution):
sf project deploy start --source-dir force-app --ignore-conflicts
If you need to rollback:
- Use Salesforce Setup → Deployment Status
- Find your deployment and click "Quick Deploy" on a previous successful deployment
sf org login web --alias staging --instance-url https://test.salesforce.com
sf project deploy start --source-dir force-app --target-org staging
sf org login web --alias production
sf project deploy validate --source-dir force-app --target-org production
sf project deploy start --source-dir force-app --target-org production
- Always validate before deploying to production
- Use version control - commit changes before deployment
- Test in sandbox first
- Deploy during maintenance windows
- Keep deployment logs for troubleshooting
- Use change sets for complex deployments across multiple orgs
For convenience, you can use the included deploy.bat
file:
deploy.bat
For deployment issues:
- Check Salesforce Setup → Deployment Status
- Review deployment logs
- Verify user permissions
- Check component dependencies
- Salesforce CLI Setup Guide
- Salesforce DX Developer Guide
- Salesforce CLI Command Reference
- Lightning Web Components Developer Guide
Note: This project is configured for sandbox deployment by default (see sfdx-project.json
). Update the sfdcLoginUrl
if deploying to production.