Code Layout

When you use the DjangoKit CLI to create a DjangoKit project, you end up with a project structure that looks like this (simplified somewhat for clarity):

NOTE: The project name and top level package name are typically the same, but this isn't required.

<project>
    src/
        <package>/
            models/
                __init__.py
            routes/
                catchall/
                    page.html  ← default 404 page
                __init__.py
                api.py
                app.html       ← app container
                layout.html    ← root layout
                page.html      ← home page
            static/
                favicon.ico
            admin.py
    pyproject.toml
    settings.development.toml
    settings.public.toml

Typically, the majority of your code will be added to the models/ and routes/ directories.