Tauri + React + FastAPI: A Modern Desktop App Scaffold 🚀

Table of Contents

• Overview
• Features
• Technologies Used
• Installation
• Usage
• Development
• Building the App
• Contributing
• License
• Links

Overview

This repository provides a modern scaffold for building cross-platform desktop applications using Tauri, React, and FastAPI. It combines the power of a Rust backend with a dynamic frontend in React, allowing developers to create responsive and efficient applications. The scaffold includes hot reload capabilities, making development seamless and efficient.

For the latest releases, please check out the Releases section.

Features

• Cross-Platform Compatibility: Build applications that run on Windows, macOS, and Linux.
• Hot Reload: See changes instantly during development without needing to restart the app.
• Python Backend: Utilize FastAPI for a robust and fast backend.
• One-Click Packaging: Easily package your application for distribution.
• Responsive UI: Use Tailwind CSS for a modern and responsive design.
• TypeScript Support: Write your frontend code in TypeScript for better type safety.
• Lightweight: Unlike Electron, Tauri apps have a smaller footprint and improved performance.

Technologies Used

• Tauri: A framework for building smaller, faster, and more secure desktop applications.
• React: A JavaScript library for building user interfaces.
• FastAPI: A modern web framework for building APIs with Python.
• Rust: A systems programming language that is fast and memory-efficient.
• Tailwind CSS: A utility-first CSS framework for creating custom designs.
• TypeScript: A superset of JavaScript that adds static types.
• Vite: A build tool that provides a faster and leaner development experience.

Installation

To get started, clone the repository and install the necessary dependencies.

git clone https://github.com/LuchoK0/tauri-react-fastapi-scaffold.git
cd tauri-react-fastapi-scaffold
npm install

Python Dependencies

Make sure you have Python installed on your machine. You can install the required Python packages using:

pip install -r backend/requirements.txt

Usage

To start the development server, run the following command:

npm run dev

This command will start both the frontend and backend servers. You can then access the application at http://localhost:3000.

Development

Frontend Development

The frontend is built using React and Vite. You can modify the files in the src directory to change the UI and add new features.

Backend Development

The backend is built using FastAPI. You can modify the files in the backend directory to change the API endpoints and business logic.

Building the App

To build the application for production, run the following command:

npm run build

This will create a production-ready build in the dist directory. You can then package your application using Tauri.

Packaging the App

To package your application, run:

npm run tauri build

This will create a standalone executable for your operating system.

Contributing

Contributions are welcome! If you have suggestions for improvements or want to add features, please fork the repository and submit a pull request.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Links

For the latest releases, visit the Releases section.

Explore the repository, and start building your next desktop application today!