https://github.com/compeydev/gitpod-electron

https://github.com/compeydev/gitpod-electron

Last synced: about 7 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/compeydev/gitpod-electron
• Owner: CompeyDev
• License: cc0-1.0
• Created: 2022-05-14T12:49:20.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-04-27T14:01:10.000Z (over 1 year ago)
• Last Synced: 2024-04-17T16:14:17.942Z (7 months ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# electron-quick-start

**Clone and run for a quick way to see Electron in action.**

This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/latest/tutorial/quick-start) within the Electron documentation.

A basic Electron application needs just these files:

- `package.json` - Points to the app's main file and lists its details and dependencies.

- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.

- `index.html` - A web page to render. This is the app's **renderer process**.

You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/latest/tutorial/quick-start).

## To Use

To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash

# Clone this repository

git clone https://github.com/electron/electron-quick-start

# Go into the repository

cd electron-quick-start

# Install dependencies

npm install

# Run the app

npm start

```

Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.

## Resources for Learning Electron

- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation

- [electronjs.org/community#boilerplates](https://electronjs.org/community#boilerplates) - sample starter apps created by the community

- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app

- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs

## License

[CC0 1.0 (Public Domain)](LICENSE.md)