https://github.com/rrcook/loe-scaffold
Scaffolding for a Lightning Web Components OSS Electron application.
https://github.com/rrcook/loe-scaffold
electron javascript lwc lwc-oss nodejs salesforce
Last synced: about 2 months ago
JSON representation
Scaffolding for a Lightning Web Components OSS Electron application.
- Host: GitHub
- URL: https://github.com/rrcook/loe-scaffold
- Owner: rrcook
- Created: 2021-08-18T19:35:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-22T20:24:41.000Z (almost 5 years ago)
- Last Synced: 2025-10-10T00:36:02.877Z (9 months ago)
- Topics: electron, javascript, lwc, lwc-oss, nodejs, salesforce
- Language: CSS
- Homepage:
- Size: 2.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# loe-scaffold
This application is a scaffolding for a Lightning Web Component OSS Electron application.
It is an expansion of what is created with [create-lwc-app](https://github.com/muenzpraeger/create-lwc-app) in ways that I find useful, and I hope you find useful as well. If you build on the native platforms you will get native applications; built on Windows 10, macOS Catalina on Intel, and Ubuntu 20.04.
The main additions to what is done with create-lwc-app:
- I added preload-based ipc communication between the renderer process and the main process, and
made a simple example sending information from renderer to main, and from main to renderer.
- I added all the libraries, resources and setup code to use the oss versions of lightning base components and slds, and used a lightning-button in the app to demonstrate. The setup steps came from
[this article](https://developer.salesforce.com/blogs/2020/12/build-connected-apps-anywhere-using-lightning-base-components).
- I added electron-forge to package the application as a true standalone electron app.
## How to start?
If building on Ubuntu, and I assume other Debian-based linuxes, first run `sudo apt-get install rpm`.
To build the project and check compilation run `npm run build` or `npm build:development`.
To run it as an electron app in development, and see your main process console.log statements,
run `npm run start`. When you're ready to make a standalone application run `npm run make`.
The main process source files are in the [`scripts`](./scripts) folder.
The renderer process source files are located in the [`src`](./src) folder. All web components are within the [`src/modules`](./src/modules) folder. The folder hierarchy also represents the naming structure of the web components.
Find more information on the main repo on [GitHub](https://github.com/muenzpraeger/create-lwc-app).