https://github.com/badr-moufad/electron-react-serialport
Template app for building robotics interfaces using web technologies (e.g. React, Material-UI)
https://github.com/badr-moufad/electron-react-serialport
arduino desktop-app electron-app interface react robotic ui
Last synced: 3 months ago
JSON representation
Template app for building robotics interfaces using web technologies (e.g. React, Material-UI)
- Host: GitHub
- URL: https://github.com/badr-moufad/electron-react-serialport
- Owner: Badr-MOUFAD
- License: mit
- Created: 2020-12-23T00:28:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-04T22:51:38.000Z (over 4 years ago)
- Last Synced: 2026-01-14T11:15:17.140Z (6 months ago)
- Topics: arduino, desktop-app, electron-app, interface, react, robotic, ui
- Language: JavaScript
- Homepage:
- Size: 3.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron React Serialport (Template App)
# Overview
This repository provides a template for creating Desktop Apps using UI web frameworks.
I mainly created this template for robotics projects, particularly to build ergonomic user interfaces to exchange easily with a microcontroller.
When using this template, you have access not only to lower system API such as serial port communication to send command to `Arduino` but also to UIs web frameworks such `React`, `Bootstrap`, ... to leverage the power of the web and thereby create astonishing UIs.
# Getting started
1. First, start with cloning this repository by running
```
git clone https://github.com/Badr-MOUFAD/electron-react-serialPort.git
```
2. Then `cd` to template directory and run the following commands to install dependencies and rebuild them to made them compatible with ``electron``
```
npm intall
npm run rebuild
```
3. Finally, compile your ``js`` files into a single one that will be accessed within the [``index.html``](https://github.com/Badr-MOUFAD/electron-react-serialPort/blob/master/index.html) file
```
npm run watch
```
To view the app, run `npm start`.
## Note
An article about this template app (motivation, project structure, getting started, ...) will be released soon, stay tuned ...
> in progress ...