README.md

LWC Garden

LWC development doesn't need to be slow and painful.
Build your Lightning Web Components locally.

View Documentation · Report Bug · Request Feature

Table of Contents

1. Screenshots
2. About The Project
   • Features
   • Built with
3. Getting Started
   • Prerequisites
   • Install LWC Garden
   • Run Local Dev Server
4. Next Steps
5. License
6. Contact

Screenshots

(back to top)

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

(back to top)

Built with

• 
• 
• 
• 

Documentation site built with Astro and Starlight.

(back to top)

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

(back to top)

Next Steps

For more information, check out the Official Documentation.

(back to top)

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.

(back to top)

Contact

Luke Secomb - @lukethacoder

Project Link: https://github.com/lukethacoder/lwc-garden

(back to top)