Site

A cross-platform application built with Flet framework, supporting desktop, web, and mobile platforms.

Table of Contents

• Overview
• Features
• Prerequisites
• Installation
• Running the Application
• Building for Production
• Project Structure
• Development
• Contributing
• License

Overview

This is a Flet-based application that can be deployed across multiple platforms including web browsers, desktop operating systems (Windows, macOS, Linux), and mobile devices (Android, iOS).

Features

• Cross-platform compatibility
• Modern UI with Flet framework
• Support for desktop, web, and mobile deployment
• Built with Python for rapid development
• Responsive design

Prerequisites

Before you begin, ensure you have one of the following installed:

• Python 3.9 or higher
• uv (recommended for faster dependency management)
• Poetry (alternative package manager)

Installation

Using uv (Recommended)

# Install uv if you haven't already
pip install uv

# Install dependencies
uv sync

Using Poetry

# Install Poetry if you haven't already
pip install poetry

# Install dependencies
poetry install

Running the Application

Development Mode

With uv

Run as a desktop application:

uv run flet run

Run as a web application:

uv run flet run --web

With Poetry

Run as a desktop application:

poetry run flet run

Run as a web application:

poetry run flet run --web

For more details on running the app, refer to the Flet Getting Started Guide.

Building for Production

Android

Build an APK package:

flet build apk -v

For more details on building and signing .apk or .aab files, refer to the Android Packaging Guide.

iOS

Build an IPA package:

flet build ipa -v

Note: iOS builds require a macOS environment with Xcode installed.

For more details on building and signing .ipa files, refer to the iOS Packaging Guide.

macOS

Build a macOS application bundle:

flet build macos -v

For more details on building macOS packages, refer to the macOS Packaging Guide.

Linux

Build a Linux package:

flet build linux -v

For more details on building Linux packages, refer to the Linux Packaging Guide.

Windows

Build a Windows executable:

flet build windows -v

For more details on building Windows packages, refer to the Windows Packaging Guide.

Web

Build for web deployment:

flet build web -v

The built files will be available in the build/web directory.

Project Structure

Site/
├── src/                    # Source code directory
│   ├── main.py            # Main application entry point
│   └── assets/            # Application assets
├── storage/               # Storage directory (gitignored)
│   ├── data/             # Application data
│   └── temp/             # Temporary files
├── build/                 # Build outputs (gitignored)
├── pyproject.toml        # Project configuration and dependencies
├── README.md             # This file
├── LICENSE               # License information
├── .gitignore            # Git ignore rules
└── .gitattributes        # Git attributes configuration

Development

Code Structure

The main application logic is located in src/main.py. You can add additional Python modules in the src directory as your application grows.

Dependencies

Dependencies are managed through pyproject.toml. The project uses:

• Flet 0.28.3 - The main framework for building the UI

To add new dependencies:

With uv:

uv add package-name

With Poetry:

poetry add package-name

Hot Reload

Flet supports hot reload during development. Changes to your Python files will automatically reload the application when running in development mode.

Contributing

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

License

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

Resources

• Flet Documentation
• Flet Examples
• Flet GitHub Repository
• Python Documentation