lwc-garden

🍃 Lightning Web Component Local Dev Server - Local First, Mocking, Slot Prefilling, Args + more

GPL-3.0 License

Stars
11
<a href="https://github.com/lukethacoder/lwc-garden/issues">Report Bug</a>

<a href="https://github.com/lukethacoder/lwc-garden/issues">Request Feature</a>

Screenshots

About The Project

LWC Garden aims to be a replacement for the official Salesforce @salesforce/lwc-dev-server, which has not received an update since 2021.

LWC Garden brings an array of new features and customisation so you can develop how you want to, locally.

Features

  • Local First Development (feat. Speedy HMR)
  • Mock Anything (Apex, OmniScript, 3rd Party Packages and on-platform imports)
  • <slot/> Placeholders
  • SLDS Support OOTB
  • API Editor via Storybook-like argTypes
  • Custom Theming API
  • Config as much or as little as your like

Built with

  • LWC
  • Webpack
  • PNPM
  • Prettier

Documentation site built with Astro and Starlight.

Getting Started

Prerequisites

Make sure you have node, pnpm and sfdx installed as well as a lwc.config.json file.

Install LWC Garden

pnpm add @lwc-garden/core

Run Local Dev Server

npx @lwc-garden/core dev

Next Steps

For more information, check out the Official Documentation.

Publishing

Only the @lwc-garden/core package should be published to npm (for now).

pnpm publish --filter @lwc-garden/core --access public

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/lwc-garden

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