https://github.com/trailheadapps/lwc-recipes-oss
A collection of easy-to-digest code examples for Lightning Web Components on any platform.
https://github.com/trailheadapps/lwc-recipes-oss
Last synced: 16 days ago
JSON representation
A collection of easy-to-digest code examples for Lightning Web Components on any platform.
- Host: GitHub
- URL: https://github.com/trailheadapps/lwc-recipes-oss
- Owner: trailheadapps
- License: cc0-1.0
- Created: 2019-05-29T15:36:45.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T13:57:50.000Z (21 days ago)
- Last Synced: 2025-04-15T03:48:38.679Z (16 days ago)
- Language: JavaScript
- Homepage: https://lwc.dev
- Size: 8.01 MB
- Stars: 334
- Watchers: 17
- Forks: 255
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Lightning Web Components Recipes Open Source
[](https://github.com/trailheadapps/lwc-recipes-oss/actions?query=workflow%3ACI) [](https://codecov.io/gh/trailheadapps/lwc-recipes-oss)
A collection of easy-to-digest code examples for Lightning Web Components Open Source. Each recipe demonstrates how to code a specific task in 30 lines of code or less. A View Source link takes you right to the code in GitHub. From Hello World to data access and third-party libraries, there is a recipe for that!
Learn more about this app by completing the Quick Start: Explore the Lightning Web Components OSS Recipes Sample App Trailhead project or by watching this short presentation video.
## Recipes Live Version
Check out [https://lwc-recipes-oss.herokuapp.com](https://lwc-recipes-oss.herokuapp.com) live on Heroku. Or on [https://recipes.lwc.dev](https://recipes.lwc.dev).
## Deploy to Heroku
If you want to deploy LWC Recipes Open Source to Heroku, you can do the following:
1. Create a Heroku application:
```
heroku create
```
2. Deploy the application:
```
git push heroku main
```
## Local Development
1. Clone the `lwc-recipes-oss` repository:
```
git clone https://github.com/trailheadapps/lwc-recipes-oss
cd lwc-recipes-oss
```
2. Install the project dependencies using `npm` (or `yarn`, if you prefer that alternatively)
```
npm install
```
3. Build the LWR static site.
```
npm run build
```
4. Start the app in watch mode.
```
npm run dev
```
5. Enjoy the app!
## Code Tours
Code Tours are guided walkthroughs that will help you understand the app code better. To be able to run them, install the [CodeTour VSCode extension](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour).