Getting Started

This document is aimed to create and run your Metronic based Django project in just 5 minutes. It's assumed that you already purchased Metronic  and downloaded from Metronic Downloads.

Pre Requirements

Here's required technology and languages to get started: Django requires Python. See the link below for the versions of Python that work with each version of Django.
What Python version can I use with Django?

Assets compile require the build tools. These libraries are required as below:

HTML Features

The Starter Kit includes only the theme source code(sass, js, media, fonts and icons) from the HTML version, build tools(Gulp, Webpack), layout views and general pages(index, authentication, error) integration.
To use any feature shown in the HTML version just copy & paste the HTML code and include required assets(css, js) using the Theme Api.

Install Python

Django is a Python web framework. See What Python version can I use with Django?  for details.

  1. Get the latest version of Python at  or with your operating system’s package manager.
  2. Download the executable installer and run it.
  3. Check the boxes next to “Install launcher for all users (recommended)” then click “Install Now”.
  4. After installation, open the command prompt and check that the Python version matches the version you installed by executing:
    python --version

How to install Pip with Get-Pip.Py

  1. To manually install pip on Windows, you will need a copy of
    curl -o
  2. Next, run the following command to install pip:
  3. Verify that pip is installed by running the previous command to check the version. Navigate to the installation location (Python\Python311\Scripts) by default.
    pip --version

Install Django

Django can be installed easily using pip.

  1. In the command prompt and execute the following command:
    python -m pip install django
    This will download and install the latest Django release.
  2. After the installation has completed, you can verify your Django installation by executing django-admin --version in the command prompt.
    django-admin --version

Build assets

Before running the application we need to build theme assets:
  1. Start a command prompt window or terminal and change directory to starterkit/_keenthemes/tools
    cd starterkit/_keenthemes/tools
  2. Install dependencies with either one, yarn or npm:
    yarn install
    You can use either one.
    npm install
    This command will fetch all dependencies listed in starterkit/_keenthemes/tools/package.json and place them into _keenthemes/tools/node_modules folder.
  3. You can use Gulp  or Webpack  commands to bundle theme assets. The below command will compile all the assets(sass, js, media) to starterkit/assets folder:
    For gulp use command:
    For webpack use command:
    npm run build
    Note on the package.json file. This step is very important for Webpack in Metronic template. The default package.json works for Gulp. To make it work for Webpack, you have to modify tools/package.json and remove "type": "module". Otherwise, it will cause compilation error when running the build command.

Run Django

To run the Django application navigate your prompt to starterkit folder and run the following command. This command will listen for changes and hot reload them.
  1. Navigate your prompt to starterkit folder.
    cd starterkit
  2. python runserver
    Keep your prompt running by default application is served on http://localhost:8000
  3. When the above runserver command is running, the warning below may appear. Run the below command to fix it. Below is an optional command to apply SQLite migration.
    You have x unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions. Run 'python migrate' to apply them.
    python migrate
Preview Get Help Buy Now