Installation¶

Requirements¶

Python 3.9 or newer
pip 21+

Basic Install¶

pip install fluxui

This installs FluxUI with all core components and the development server.

Optional Extras¶

Charts¶

Adds Plotly integration and the ui.Chart component:

pip install "fluxui[charts]"

Enables app.run(share=True) to create a temporary public tunnel URL (powered by localtunnel):

pip install "fluxui[share]"

Everything¶

pip install "fluxui[all]"

Development Install¶

If you are contributing to FluxUI or want to run the test suite:

git clone https://github.com/Minato3000/FluxApp.git
cd FluxApp
pip install -e ".[dev]"

The dev extra pulls in pytest, pytest-asyncio, watchfiles, mypy, and ruff.

Verify the Install¶

fluxui --help

You should see:

Usage: fluxui [OPTIONS] COMMAND [ARGS]...

  FluxUI — reactive Python web UI framework

Options:
  --help  Show this message and exit.

Commands:
  export-docker  Generate Dockerfile + docker-compose.yml.
  new            Scaffold a new FluxUI project.
  run            Start the FluxUI development server.

Scaffold a New Project¶

The fastest way to start:

fluxui new my_app
cd my_app
pip install fluxui
fluxui run app.py

This creates:

my_app/
├── app.py          # your FluxUI app
├── pyproject.toml  # project metadata
├── .gitignore
└── README.md

The generated app.py is a working counter demo you can immediately run and edit.

Virtual environments

Always install FluxUI inside a virtual environment to avoid dependency conflicts:

python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install fluxui