Open-Source Cross-Platform Serial Monitor written using Electron and NodeJS
Serial Dev is an open source serial port monitor built on ElectronJS and aims to provide an intuitive and uniform experience for monitoring and sending serial data on all of the users platforms. The project is open source with the hope that others can get use, improve, and learn from it. Contributions are absolutely welcome and if you are interested in doing so, please visit the Contributing section.
The application is built with two primary tools. Both are required to build and develop this project.
To get a local copy of the source up and running follow these simple steps
$ git clone https://github.com/stephendpmurphy/serial-dev.git$ npm installTo build the application, you will first need to compile the styling sass source:
$ npm run compile:sassOnce complete, you can run the application:
$ npm startYou can debug the application within VScode by first installing the Chrome Debugging Extension for VScode. With the extension installed, you can debug both the Main and Renderer processes by using the "Electron: All" target.
To create a distributable package using electron-forge:
$ npm run makeAny contributions you make are greatly appreciated. You can contribute to the project by following this workflow
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Stephen Murphy - @smurphy_iii - [email protected]
Project Link: Serial Dev