sfdx-starter

⚡ on platform sfdx project starter with some base config, scripts and a custom lwc-local-dev-server (LWC Garden)

GPL-3.0 License

Stars
2
<a href="https://github.com/lukethacoder/sfdx-starter/issues">Request Feature</a>

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)

Built with

  • LWC
  • PNPM
  • Jest
  • Prettier

Getting Started

Prerequisites

Make sure you have node, pnpm and sfdx installed.

Installation

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

fflib/at4dx

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

Run the script with:

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

For more info, and an updated script

LWC Local Development

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

This can be run locally using:

npx @lwc-garden/core 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.

License

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

Contact

Luke Secomb - @lukethacoder

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

Badges
Extracted from project README
Stargazers Issues MIT License LinkedIn LWC PNPM Jest Prettier