Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

⚡ on platform sfdx project starter with some base config, scripts and a custom lwc-local-dev-server (LWC Garden)
https://github.com/lukethacoder/sfdx-starter

apex-enterprise-patterns at4dx fflib lwc-garden lwc-local-dev-server salesforce salesforce-developers salesforcedx sfdx

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/lukethacoder/sfdx-starter
Owner: lukethacoder
License: gpl-3.0
Created: 2020-05-24T07:04:11.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-10-18T22:19:55.000Z (3 months ago)
Last Synced: 2024-10-20T05:34:28.184Z (3 months ago)
Topics: apex-enterprise-patterns, at4dx, fflib, lwc-garden, lwc-local-dev-server, salesforce, salesforce-developers, salesforcedx, sfdx
Language: JavaScript
Homepage:
Size: 1.71 MB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        






  

    

  

sfdx-starter

  

    quick start template for on-platform SFDX based projects.

    


    


    

    Report Bug

    ·

    Request Feature

  

  

  

  [![Stargazers][stars-shield]][stars-url]

  [![Issues][issues-shield]][issues-url]

  [![MIT License][license-shield]][license-url]

  [![LinkedIn][linkedin-shield]][linkedin-url]



  Table of Contents

  


    

      About The Project

      

        Features

        Built with

      

    

    

      Getting Started

      

        Prerequisites

        Installation

        fflib/at4dx

      

    

    

      

        LWC Local Development

      

    

    

      Jest Testing

    

    License

    Contact

  


## About The Project

### Features

- 🍃 lwc-local-dev-server ([LWC Garden](https://lwc.garden?utm_campaign=sfdx-starter))

- ⚖️ 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

- [![LWC][lwc]][lwc-url]

- [![PNPM][pnpm]][pnpm-url]

- [![Jest][jest]][jest-url]

- [![Prettier][prettier]][prettier-url]

(back to top)


## Getting Started

### Prerequisites

Make sure you have [`node`](https://nodejs.org/en), [`pnpm`](https://pnpm.io/) and [`sfdx`](https://developer.salesforce.com/tools/salesforcecli) installed.

### Installation

1. Go to [lukethacoder/sfdx-starter](https://github.com/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](https://github.com/apex-enterprise-patterns).

- [fflib-apex-common](https://github.com/apex-enterprise-patterns/fflib-apex-common)

- [fflib-apex-mocks](https://github.com/apex-enterprise-patterns/fflib-apex-mocks)

- [force-di](https://github.com/apex-enterprise-patterns/force-di)

- [at4dx](https://github.com/apex-enterprise-patterns/at4dx)

Run the script with:

```cmd

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

```

> [For more info, and an updated script](https://gist.github.com/lukethacoder/dd2af8ef3cc344b6dc15a9cd6a5569f2)

(back to top)


## LWC Local Development

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

This can be run locally using:

```cmd

npx @lwc-garden/core dev

```

Read the [LWC Garden Documentation](https://lwc.garden/) for more information.

## Jest Testing

All tests can be run using:

```cmd

pnpm test

```

Jest testing uses the [`@lwc/jest-*`](https://github.com/salesforce/lwc-test) packages, not [`@salesforce/sfdx-lwc-jest`](https://github.com/salesforce/sfdx-lwc-jest).

(back to top)


## License

Distributed under the GNU General Public License v3.0. See [LICENSE](https://github.com/lukethacoder/sfdx-starter/blob/main/LICENSE) for more information.

(back to top)


## Contact

[Luke Secomb]([license-url]) - [@lukethacoder](https://github.com/lukethacoder)

Project Link: [https://github.com/lukethacoder/sfdx-starter](https://github.com/lukethacoder/sfdx-starter)

(back to top)


[forks-shield]: https://img.shields.io/github/forks/lukethacoder/sfdx-starter.svg?style=for-the-badge

[forks-url]: https://github.com/lukethacoder/sfdx-starter/network/members

[stars-shield]: https://img.shields.io/github/stars/lukethacoder/sfdx-starter.svg?style=for-the-badge

[stars-url]: https://github.com/lukethacoder/sfdx-starter/stargazers

[issues-shield]: https://img.shields.io/github/issues/lukethacoder/sfdx-starter.svg?style=for-the-badge

[issues-url]: https://github.com/lukethacoder/sfdx-starter/issues

[license-shield]: https://img.shields.io/github/license/lukethacoder/sfdx-starter.svg?style=for-the-badge

[license-url]: https://github.com/lukethacoder/sfdx-starter/blob/main/LICENSE

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://www.linkedin.com/in/luke-secomb/

[product-screenshot]: docs/screenshot.png

[lwc]: https://img.shields.io/badge/lwc-009ddb?style=for-the-badge&logo=salesforce&logoColor=white

[lwc-url]: https://lwc.dev

[prettier]: https://img.shields.io/badge/Prettier-1a2b34?style=for-the-badge&logo=prettier&logoColor=white

[prettier-url]: https://prettier.io/

[pnpm]: https://img.shields.io/badge/pnpm-4e4e4e?style=for-the-badge&logo=pnpm

[pnpm-url]: https://lwc.dev

[jest]: https://img.shields.io/badge/jest-99425b?style=for-the-badge&logo=jest&logoColor=white

[jest-url]: https://github.com/jestjs/jest