27 lines
1.5 KiB
Markdown
27 lines
1.5 KiB
Markdown
|
# Electron & Tauri React/FastAPI Boilerplates
|
|||
|
|
|
|||
|
|
Two bootstrap scripts that generate a React (Vite) + FastAPI + SQLite stack, one packaged with Electron and one with Tauri.
|
|||
|
|
Good for creating Full Stack web applications, with a Python backend, especially good for the use of machine learning models, a SQLite Database for maximum portability and readability, and a JavaScript frontend, for the best UI / UX designs possible.
|
|||
|
|
|
|||
|
|
## Scripts
|
|||
|
|
- `electron_boilerplate.sh` – scaffolds Electron + React + FastAPI, installs deps, and launches the app. Includes a `run.sh` helper in the generated project to start backend, Vite dev server, and Electron together.
|
|||
|
|
- `tauri_boilerplate.sh` – scaffolds Tauri + React + FastAPI, installs deps, and launches the app. Generated `run.sh` starts the backend and `tauri dev`.
|
|||
|
|
|
|||
|
|
## Requirements
|
|||
|
|
- Node.js and npm
|
|||
|
|
- Python 3 with venv support
|
|||
|
|
- For Tauri: Rust toolchain (`cargo`) and platform-specific Tauri prerequisites
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
```bash
|
|||
|
|
./electron_boilerplate.sh [project-name]
|
|||
|
|
./tauri_boilerplate.sh [project-name]
|
|||
|
|
```
|
|||
|
|
- If no name is provided, the script prompts for one (letters, numbers, `_`, `-`).
|
|||
|
|
- Scripts create backend venv, install backend/frontend deps, then auto-run the app.
|
|||
|
|
- Generated projects include:
|
|||
|
|
- FastAPI backend with SQLite, REST + WebSocket, `uvicorn --reload`
|
|||
|
|
- React + Vite frontend with ESLint and WS demo
|
|||
|
|
- README and `run.sh` for one-command dev start
|
|||
|
|
- Electron window title uses the project name; Tauri window/product name and identifier use the project name.
|