https://github.com/serialport/electron-serialport
An example of how to use serialport in an electron app
https://github.com/serialport/electron-serialport
Last synced: 7 months ago
JSON representation
An example of how to use serialport in an electron app
- Host: GitHub
- URL: https://github.com/serialport/electron-serialport
- Owner: serialport
- License: cc0-1.0
- Created: 2016-12-27T01:46:18.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T12:50:23.000Z (about 2 years ago)
- Last Synced: 2025-06-19T01:21:51.062Z (7 months ago)
- Language: JavaScript
- Size: 276 KB
- Stars: 387
- Watchers: 18
- Forks: 162
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# electron-serialport
An example of how to use serialport in an electron app
**Clone and run for a quick way to see Electron and Serialport in action.**
This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation.
**Use this app along with the [Electron API Demos](http://electron.atom.io/#get-started) app for API code examples to help you get started.**
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](http://electron.atom.io/docs/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/serialport/electron-serialport.git
# Go into the repository
cd electron-serialport
# Install dependencies
npm install
# Run the app
npm start
```
Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/).
## Other Example Apps
For more example apps, see the
[list of boilerplates](http://electron.atom.io/community/#boilerplates)
created by the awesome electron community.
#### License [CC0 1.0 (Public Domain)](LICENSE.md)