Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 3.82 KB

PREREQS.md

File metadata and controls

48 lines (32 loc) · 3.82 KB

AppExchange Demo Kit (ADK) - Prerequisites

To effectively use the AppExchange Demo Kit (ADK), your Salesforce, GitHub, and Local development environments must meet the following prerequisites.

Salesforce Environment Prerequisites

Prerequisite Reason More Info
Access to a Developer Hub Required for creating scratch orgs Enable the Dev Hub in Your Org
Create Salesforce DX Users Required for developers to access your Dev Hub Add Salesforce DX Users
Access to a Packaging Org Optional if creating managed/unmanaged packages Overview of Salesforce Packages

Git / GitHub Environment Prerequisites

Prerequisite Reason More Info
Create a GitHub account Required for publication / sharing of your ADK project on GitHub Join GitHub (free account signup)
Install / configure Git locally Required to use Git locally and with Git remotes like GitHub Set up Git
Invite collaborators (personal) Optional. Support team development with a personal account Invite Collaborators (personal)
Invite collaborators (organization) Optional. Support team development with an organization account Invite Collaborators (organization)

Local Environment Prerequisites

Prerequisite Reason More Info
OS, developer toolset, IDE and VCS Required by the Salesforce CLI Salesforce DX System Requirements
Install the Salesforce CLI Required by the demo installation scripts Install the Salesforce CLI

Important Note for Windows Users

The core functionality of the ADK is driven by the SFDX-Falcon CLI Plugin which runs cross-platform on Mac, Linux, and Windows. There are, however, optional shell scripts provided in the tools directory that use syntax supported by the Bash shell (and its cohorts, like Zsh).

Windows 10 users can enable the "Windows Subsystem for Linux" feature and install the Bash shell. There's a great walkthrough that shows you How to Install and Use the Linux Bash Shell on Windows 10 over at HowToGeek.com.