Giter VIP home page Giter VIP logo

koderzi / electron-dev Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 66 KB

This repository provides a development environment for Electron using VSCode and Dev Container. It allows you to easily set up a local Electron environment for development purposes. It comes pre-installed with a terminal command called electron-dev to help you create a VNC virtual display.

License: MIT License

Dockerfile 9.66% Shell 90.34%
dev-container development docker electron vscode

electron-dev's Introduction

electron-dev - Dockerized Electron Development Environment

This repository provides a development environment for Electron using VSCode and Dev Container. It allows you to easily set up a local Electron environment for development purposes. It comes pre-installed with a bash script called electron-dev, which helps you manage various tasks such as creating a VNC virtual display, starting the Electron app and quitting the VNC virtual display.

Prerequisites

Before using this repository, make sure you have the following installed on your system:

  • Docker Desktop
  • VSCode with Dev Container extension installed
  • Alternative: Remote Repositories extension for VSCode
  • VNC viewer installed (e.g., TigerVNC)

Usage

To use the electron-dev script, run the following command:

electron-dev [COMMAND]

Available commands:

  • -h, --help: Show the help message.
  • -c, --create-display: Create a VNC virtual display.
  • -s, --start-app: Start the Electron app.
  • -q, --quit-display: Quit the VNC virtual display.

How to use:

  1. Create a VNC virtual display by using command electron-dev -c in the VSCode terminal.
  2. Start TigerVNC and connect to localhost:5900. (Make sure to connect without authentication)
  3. Once connected, you can start your Electron app using command electron-dev -s. (Make sure that you are in the app directory before starting)

electron-dev's People

Contributors

koderzi avatar

Stargazers

 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.