sfdx-starter

quick start template for on-platform SFDX based projects.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built with
2. Getting Started
   • Prerequisites
   • Installation
   • fflib/at4dx
3. LWC Local Development
4. Jest Testing
5. License
6. Contact

About The Project

Features

• 🍃 lwc-local-dev-server (LWC Garden)
• ⚖️ fflib/at4dx install script
• 💅 prettier & eslint config (feat. githooks to enforce node_modules install)
• 🧪 Jest Testing
• 📜 helper scripts
• ⚙️ project-scratch-def.json config for communities, cms and knowledge
• ✅ .vscode/tasks.json Metadata tasks (Ctrl + Shift + B)
• 🙈 .vscode/settings.json to hide .xml files and less commonly used metadata. (This can be edited)

(back to top)

Built with

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

Make sure you have node, pnpm and sfdx installed.

Installation

1. Go to lukethacoder/sfdx-starter
2. Click "Use this template"

(back to top)

fflib/at4dx

The script installs the following packages as a part of the apex-enterprise-patterns.

• fflib-apex-common
• fflib-apex-mocks
• force-di
• at4dx

Run the script with:

node --harmony setup-fflib.mjs e- ORG_ALIAS

For more info, and an updated script

(back to top)

LWC Local Development

We use the @lwc-garden/utils package to facilitate local LWC development.

This can be run locally using:

pnpm dev

Read the LWC Garden Documentation for more information.

Jest Testing

All tests can be run using:

pnpm test

Jest testing uses the @lwc/jest-* packages, not @salesforce/sfdx-lwc-jest.

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

(back to top)

Contact

Luke Secomb - @lukethacoder

Project Link: https://github.com/lukethacoder/sfdx-starter

(back to top)