Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rudifa/electron-quick-start-ipc
https://github.com/rudifa/electron-quick-start-ipc
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rudifa/electron-quick-start-ipc
- Owner: rudifa
- License: cc0-1.0
- Created: 2022-10-23T16:33:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-13T13:39:06.000Z (about 1 year ago)
- Last Synced: 2024-10-06T01:41:19.213Z (about 1 month ago)
- Language: JavaScript
- Size: 84 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**.
- `preload.js` - A content script that runs before the renderer process loads.
You can learn more about each of these components in depth within the [Tutorial](https://electronjs.org/docs/latest/tutorial/tutorial-prerequisites).
## 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
- [Electron Fiddle](https://electronjs.org/fiddle) - Electron Fiddle, an app to test small Electron experiments
## License
[CC0 1.0 (Public Domain)](LICENSE.md)
## Notes rudifa
### A TODO app based on a Twilio tutorial and on Electron IPC tutorial
[An Introduction to Building Desktop Applications with Electron](https://www.twilio.com/blog/an-introduction-to-building-desktop-applications-with-electron)
[Inter-Process Communication](https://www.electronjs.org/docs/latest/tutorial/ipc)