README.md

Electron, React & Python Template

Multi-platform Electron template, using React & Redux Toolkit with Python/Flask microservices.

🛠️ Setup

Ensure you have Node and Python installed, then clone this repository. After it's cloned, navigate to the project's root directory on your computer and run the following scrips in a terminal application (e.g., Git Bash):

Install Python dependencies:

pip3 install -r requirements.txt

Install Node dependencies:

yarn install

⚙️ Config

Electron: Electron's main.js, preload.js, and renderer.js files can be found in the project's root directory.

React: React files can be found in the ./src/ folder, the custom toolbar is in ./src/components/toolbar.

Python: Python scripts can be created in the ./app.py file and used on events via REST calls.

📜 Scripts

Below are the scripts you'll need to run and package your application, as well as build out JSDoc documentation, if you choose to do so. An exhaustive list of scripts that are available can be found in the package.json file of the project's root directory, in the scripts section.

⚠️  When packaging, you must install PyInstaller and add its path in your environment variables. The name of your package in package.js must also match the name field in package.json.

Start Developer Mode:

yarn run start

Package Windows: ¹

yarn run build:package:windows

Package macOS:

yarn run build:package:mac

Package Linux:

yarn run build:package:linux

Build Documentation:

yarn run build:docs

¹Windows uses electron-wix-msi, you must install and add its path to your environment variables.

🐱‍👓 Docs

Code documentation for this template, created with JSDoc, can be found here:
Electron, React, & Python Template

🦟 Bugs

Bugs reported on the project's issues page will be exterminated as quickly as possible, be sure to include steps to reproduce so they can be spotted easily.

🏷️ License

MIT © iPzard