README.md

Tython SFDX Project Template

Dev, Build and Test

Todo WIP.

1. Run npm install to bring in all development dependencies.

2. Use SFDX to create new LWC; Note files will auto-lint on git commit.

3. Scripts to spin up scratch orgs included; Note project name is needed (see scripts/create-scratch-org.sh)

Resources

https://github.com/trailheadapps/lwc-recipes https://github.com/trailheadapps/ebikes-lwc https://github.com/dreamhouseapp/dreamhouse-lwc

Description of Files and Directories

force-app/ is the main src directory. Note tests/ here is for global testing utils/mocks. Individual component unit test files live in the same folder as said component.

scripts/ directory contains shell scripts for orchestrating project flows

data/ folder contains sample data for hydrating a newly created scratch org

.circleci directory houses continuous integration configs; Note that this requires creating a Connected App in the Salesforce org and then hooking into CircleCI how to

.editorconfig contains common editor settings for our projects. Note that VSCode currently requires an extension (see below)

.vscode/ contains VSCode-specific editor settings and extension recommendations for sharing amongst team members

Recommended Extensions for VSCode

Salesforce Extension pack bundle, incl LWC, Apex, CLI support

ESLint

Editor config

Markdown Linter

Issues

-Should we add automatic __tests__ folder/file creation when creating new LWC?

-Should unit test scripts be run on pre-commit?

-Install stylelint for css, can be added to lint-staged