https://github.com/lukethacoder/lwc-garden
🍃 Lightning Web Component Local Dev Server - Local First, Mocking, Slot Prefilling, Custom Labels, Args + more
https://github.com/lukethacoder/lwc-garden
lightning-web-components local-development lwc-garden lwc-local-dev-server salesforce
Last synced: 3 months ago
JSON representation
🍃 Lightning Web Component Local Dev Server - Local First, Mocking, Slot Prefilling, Custom Labels, Args + more
- Host: GitHub
- URL: https://github.com/lukethacoder/lwc-garden
- Owner: lukethacoder
- License: gpl-3.0
- Created: 2024-03-25T09:23:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T06:33:01.000Z (4 months ago)
- Last Synced: 2025-03-17T08:44:07.040Z (3 months ago)
- Topics: lightning-web-components, local-development, lwc-garden, lwc-local-dev-server, salesforce
- Language: TypeScript
- Homepage: https://lwc.garden
- Size: 2.73 MB
- Stars: 28
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LWC Garden
LWC development doesn't need to be slow and painful.
Build your Lightning Web Components locally.
View Documentation
·
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
## Screenshots
![product-screenshot]
![product-screenshot-2]
![product-screenshot-3]
## About The Project
LWC Garden aims to be a replacement for the official Salesforce [`@salesforce/lwc-dev-server`](https://www.npmjs.com/package/@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)
- 🥧 `` 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][lwc]][lwc-url]
- [![Webpack][webpack]][webpack-url]
- [![PNPM][pnpm]][pnpm-url]
- [![Prettier][prettier]][prettier-url]
> Documentation site built with [Astro](https://astro.build/) and [Starlight](https://starlight.astro.build/).
## 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 as well as a `lwc.config.json` file.
### Install LWC Garden
```bash
pnpm add @lwc-garden/core
```
### Run Local Dev Server
```bash
npx @lwc-garden/core dev
```
## Next Steps
For more information, check out the [Official Documentation](https://lwc.garden).
![docs-screenshot]
## Package Development
You can test the local package using
```bash
npx -p @lwc-garden/core dev
```
## Publishing
Publish the `@lwc-garden/core` package:
```bash
pnpm publish --filter @lwc-garden/core --access public
```
Publish the `@lwc-garden/utils` package:
```bash
pnpm publish --filter @lwc-garden/utils --access public
```
## License
Distributed under the GNU General Public License v3.0. See [LICENSE](https://github.com/lukethacoder/lwc-garden/blob/main/LICENSE) for more information.
## Contact
[Luke Secomb]([license-url]) - [@lukethacoder](https://github.com/lukethacoder)
Project Link: [https://github.com/lukethacoder/lwc-garden](https://github.com/lukethacoder/lwc-garden)
[forks-shield]: https://img.shields.io/github/forks/lukethacoder/lwc-garden.svg?style=for-the-badge
[forks-url]: https://github.com/lukethacoder/lwc-garden/network/members
[stars-shield]: https://img.shields.io/github/stars/lukethacoder/lwc-garden.svg?style=for-the-badge
[stars-url]: https://github.com/lukethacoder/lwc-garden/stargazers
[issues-shield]: https://img.shields.io/github/issues/lukethacoder/lwc-garden.svg?style=for-the-badge
[issues-url]: https://github.com/lukethacoder/lwc-garden/issues
[license-shield]: https://img.shields.io/github/license/lukethacoder/lwc-garden.svg?style=for-the-badge
[license-url]: https://github.com/lukethacoder/lwc-garden/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.jpg
[product-screenshot-2]: docs/screenshot-2.jpg
[product-screenshot-3]: docs/screenshot-3.jpg
[docs-screenshot]: docs/screenshot-docs.jpg
[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://pnpm.io/
[webpack]: https://img.shields.io/badge/webpack-6ea6c1?style=for-the-badge&logo=webpack
[webpack-url]: https://webpack.js.org/