This project was bootstrapped with Create React App using the electron-python-fastapi template.
In the project directory, you can run:
Runs the app in the development mode within a local ElectronJS window.
Open http://localhost:3000 to view it in the browser.
This will also start the FastAPI server running on http://localhost:8000, allowing for access to a Python API. By default, the API requires a shared SECRET_KEY which is randomly generated when the server is started.
Note that Python >3.6 and Python dependencies specified in requirements.txt are required for development.
The page will reload if you make edits.
You will also see any lint errors in the console.
Package and build a ready for distribution application for Windows. This template uses electron-builder for packaging and by default outputs a NSIS installer for Windows.
Note that FastAPI and Uvicorn are also packaged up within the installer. It is highly recommended to perform the build within a project virtual environment to minimise build size.
Remember to change the author, description, build.appId and build.productName in package.json before creating a distributable
Package and build a ready for distribution application for macOS. This template uses electron-builder for packaging and by default outputs a dmg installer for macOS.
Note that FastAPI and Uvicorn are also packaged up within the installer. It is highly recommended to perform the build within a project virtual environment to minimise build size.
Remember to change the author, description, build.appId and build.productName in package.json before creating a distributable
Package and build a ready for distribution application for Linux. This template uses electron-builder for packaging and by default outputs a deb installer for Linux.
Note that FastAPI and Uvicorn are also packaged up within the installer. It is highly recommended to perform the build within a project virtual environment to minimise build size.
Remember to change the author, description, build.appId and build.productName in package.json before creating a distributable
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.