Get Started

Note

Documentation is a work in progress.

The easiest way to get started is to use the DjangoKit CLI to generate a ready-to-go project structure.

To get started, first install uv and the DjangoKit CLI. uv can be installed in a variety of ways. For example:

brew install uv
pipx install uv
pip —user install uv

See the uv installation docs for more options.

uv tool install org-djangokit-cli

Once uv and the DjangoKit CLI are installed, run the following command in your terminal, replacing <name> with the name of your project (e.g., if you're creating a blog, you might use "Blog" as the name).

dk create-project <name>

After going through the prompts and creating the project, change into your new project directory and install the project locally:

# Replace <project> with your project name
cd <project>

dk setup

dk setup does the following:

Creates a virtualenv for your project
Installs your project and its dependencies into the virtualenv
Runs the initial Django migrations

Now you can run the dev server:

dk start