/pywebview-react-boilerplate

This is a simple boilerplate to help you start with pywebview and React.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

pywebview-react-boilerplate

This is a simple boilerplate to help you start with pywebview and React. It sets up the development environment, install dependencies, as well as provides scripts for building an executable. Stack is based on Pywebview, React (create-react-app), SASS, Pyinstaller (Windows/Linux) and Py2app (macOS).

Requirements

  • Python 3
  • Node
  • virtualenv

Installation

yarn run init

This will create a virtual environment, install pip and Node dependencies. Alternatively you can perform these steps manually.

yarn install
pip install -r requirements.txt

On Linux systems installation system makes educated guesses. If you run KDE, QT dependencies are installed, otherwise GTK is chosen. apt is used for installing GTK dependencies. In case you are running a non apt-based system, you will have to install GTK dependencies manually. See installation for details.

Usage

To launch the application.

yarn run start

To build an executable. The output binary will be produced in the dist directory.

yarn run build

To start a development server (only for testing frontend code).

yarn run dev

To clean the developement environment, this will delete gui, dist, build directories.

yarn run clean

To eject create-react-app and tweak the configuration as you may wish.

yarn run eject

To test the frontend code if you have written tests.

yarn run frontend:test

Bug reporting

Please report pywebview related bugs directly to pywebview's repository. This repository is only for the issues related to this boilerplate.