Skip to content

Getting started

Clone the repository, install dependencies with uv, and run the Flet app or these docs locally.

Prerequisites

  • Git
  • uv (manages Python and dependencies)
  • Python 3.12+ (uv can install it if needed)

Clone

git clone https://github.com/BartoszKog/my-first-learning-app.git
cd my-first-learning-app

Repository: github.com/BartoszKog/my-first-learning-app.

Run the application

From the repository root:

uv sync
uv run flet run .

uv sync creates the virtual environment and installs runtime dependencies. The thin launcher src/main.py calls ft.run on learning_app.app.main. Application code and Flet assets live under src/ so packaging (flet build / flet test) does not include docs/ or tests/.

Serve these docs

Install the dev dependency group (MkDocs Material, mkdocstrings, …), then serve:

uv sync --group dev
uv run mkdocs serve

Open http://127.0.0.1:8000 in your browser.

Build a static site into site/:

uv run mkdocs build

Troubleshooting

Symptom What to check
Sets or catalog missing after restart Confirm FilePathManager.initialize() ran and storage under FLET_APP_STORAGE_DATA (or the CWD fallback) is writable. See Data and storage.
Import blocked with “restart the app” files.csv failed validate_files_csv. Restart after fixing or repairing the catalog; see Import and export.
Docs build noisy / --strict fails Prefer uv run mkdocs build without --strict while iterating. Strict mode can fail on Griffe type-annotation warnings from generated API pages (for example app_theme).

Next steps

  1. Architecture — how the package is wired.
  2. Navigation and Layout — day-to-day routing and sizing.
  3. Adding a screen — first change workflow.
  4. Home — full documentation map.