Skip to content

Developer Documentation

Igor Androsov edited this page Sep 27, 2024 · 5 revisions

Developer Documentation

Prerequisites

You need all these things set up before proceeding.

How to install UnsubscribeLink from the source code

1. Clone the GitHub branch on the local system.

git clone https://github.com/SFDO-Community/UnsubscribeLink

Or Clone using Github-Desktop https://docs.github.com/en/desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop

2. Authenticate developer or playground org in VS code (if you have not already)

Using sf command sf org login web --alias set-alias-for-org

Or auth with the VS code extension. https://www.apexhours.com/how-to-setup-visual-studio-code-for-salesforce/

3. Enable Digital Experiences in your developer or playground org

Setup > Digital Experiences > Settings > Enable Digital Experiences > Save Set the dev hub for the package in VS Code to your org

4. Deploy the project metadata to the target org.

Right-click on the “force-app” folder and select "SFDX: Deploy This Source to Org" Setup the rest of the org based on installation instructions. As we have already deployed the dev package code, skip the Package installation part.

Create a Scratch Org

The UnsubscribeLink is a Salesforce DX project that can deploy to a target org in two methods.

Deploy as metadata using scratch or developer/playground org.

If you are a developer and want to customize or test-drive this app in a scratch org, this repo provides a helper script that allows for Quick Start. Follow bellow commands to set up a new scratch org.

$ git clone https://github.com/SFDO-Community/UnsubscribeLink

$ cd UnsubscribeLink

$ scripts/dx/dxorg <org alias> <OPTIONAL: days to live for scratch org 1-30. Default 30>

After this script executes the new scratch org will be created from your DevHub and the source code pushed to the new org. At this point you are ready to test and build. Happy blazing new trails.

Now you have new org and this app deployed, what’s next? Here are some documentation resources to get you started if you are new to source-driven development.

Post Installation requirements

TBD

How Do You Plan to Deploy Your Changes?

Do you want to deploy a set of changes, or create a self-contained application? Choose a development model.

New to development & VSCode

This Quick Start: Visual Studio Code for Salesforce Development on Trailhead can help to learn and set up you VSCode developer tools.

Configure Your Salesforce DX Project

The sfdx-project.json file contains useful configuration information for your project. See Salesforce DX Project Configuration in the Salesforce DX Developer Guide for details about this file.

Developer Resources