Code Monkey home page Code Monkey logo

loe-scaffold's Introduction

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 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.
  • 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 folder.

The renderer process source files are located in the src folder. All web components are within the src/modules folder. The folder hierarchy also represents the naming structure of the web components.

Find more information on the main repo on GitHub.

loe-scaffold's People

Contributors

rrcook avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.