reflex-django 0.4.0

Run a Django backend (Django ORM, Django Admin) alongside a Reflex app.

reflex-django

Django + Reflex in one process — configure in urls.py, pages in views.py.

Documentation · GitHub · PyPI

---

What it does

• Django — /admin, /api, ORM, migrations, sessions
• Reflex — SPA UI, client routes, WebSocket events
• One command — python manage.py run_reflex
• No myapp/myapp.py — pages in myapp/views.py, app loaded via django_led_app

Reflex settings go in reflex_mount() in urls.py, not in a large rxconfig.py.

---

Minimal setup (copy-paste)

Install

uv add django reflex reflex-django

config/settings.py

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "reflex_django",
    "shop",  # your app
]

MIDDLEWARE = [
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "reflex_django.streaming_middleware.AsyncStreamingMiddleware",  # ASGI streaming
]

ROOT_URLCONF = "config.urls"

config/urls.py

from django.contrib import admin
from django.urls import path
from reflex_django.urls import reflex_mount

urlpatterns = [path("admin/", admin.site.urls)]

urlpatterns += [
    reflex_mount(
        app_name="shop",
        django_prefix=("/admin",),
        rx_config={"frontend_port": 3000, "backend_port": 8000},
    ),
]

shop/views.py — pages + AppState

import reflex as rx
from reflex_django import template
from reflex_django.state import AppState


class HomeState(AppState):
    message: str = "Hello"

    @rx.event
    async def on_load(self):
        if self.request.user.is_authenticated:
            self.message = f"Hello, {self.request.user.get_username()}"
        else:
            self.message = "Hello, guest"


@template(route="/", title="Home")
def index() -> rx.Component:
    return rx.vstack(
        rx.heading("Home"),
        rx.text(HomeState.message),
    )

Run

python manage.py migrate
python manage.py run_reflex

Open http://localhost:3000/ — admin at http://localhost:3000/admin/

Full walkthrough: Quickstart

---

Three files to remember

File	You configure
settings.py	INSTALLED_APPS, MIDDLEWARE (incl. AsyncStreamingMiddleware)
urls.py	reflex_mount(app_name=..., django_prefix=..., rx_config={...})
{app}/views.py	@template(route=...) pages and AppState subclasses

---

AppState in one minute

Subclass AppState when a page needs the Django user or session:

from reflex_django.state import AppState

class MyState(AppState):
    @rx.event
    async def on_load(self):
        user = self.request.user          # Django User
        if user.is_authenticated:
            ...
        self.request.session["key"] = "value"
        await self.request.session.asave()

The event bridge attaches self.request on every WebSocket event (same cookies as /admin/).

---

Why reflex-django?

Reflex uses WebSockets for UI events — Django middleware does not run there by default. reflex-django adds an event bridge so self.request.user and sessions work in @rx.event handlers.

Django	Python
6.0.x	3.12+

---

Documentation

Topic	Link
Quickstart (step-by-step)	quickstart.md
reflex_mount() reference	configuration.md
AsyncStreamingMiddleware	async_streaming_middleware.md
Pages in views.py	pages_in_views.md
URLs & django_led_app	django_urls.md
Brownfield Django	existing_django_project.md
Auth & permissions	authentication.md

Site: https://mohannadirshedat.github.io/reflex-django/

---

Commands

python manage.py run_reflex      # dev server
python manage.py migrate
python manage.py createsuperuser

---

Author: Mohannad Irshedat · GitHub