Prerequisites

Here's required technology and languages to get started:

• Python 3.10+
• Django 5.0+
• Git

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

• Node.js (LTS)
• Gulp
• Yarn

Install Python

Python is the programming language that Django is built with. Django is a Python web framework. See What Python version can I use with Django? for details.

To check if Python is already installed on your system, open your terminal/command prompt and run:

python --version

If Python is not installed, follow these steps to install it:

1. Download Python for macOS from the official website: python.org/downloads
2. Run the installer and make sure to check the box that says "Add Python to PATH" before clicking "Install Now."

For Linux, you can use your package manager to install Python. For example, on Ubuntu, you can use:

sudo apt-get update
sudo apt-get install python3

Install PIP

To check if PIP is already installed on your system, open your terminal/command prompt and run:

pip --version

Installing Pip using get-pip.py

1. Download the script, from https://bootstrap.pypa.io/get-pip.py.
2. Open a terminal/command prompt, cd to the folder containing the get-pip.py file and run:

python get-pip.py

# For Python 2 or lower
python get-pip.py

# For Python 3
python3 get-pip.py

C:> py get-pip.py

Build Assets

Before running the application we need to build theme assets from full-version/src/ or starter-kit/src/ folder:

1. Open terminal/command prompt and change directory to src/
Copy

cd src

2. Install dependencies with either one, yarn or npm:
Tip: It's recommended to use YARN over NPM. In a comparison of speed, Yarn is much quicker and faster than most of the npm versions.
Copy

# For Yarn
yarn

# For npm
npm install --legacy-peer-deps

3. You can use below commands to bundle theme assets. The below command will compile all the assets(sass, js, media) to src/assets folder:
Tip: While Django application development, use a "watch" task to automatically compile asset file changes and instantly observe their effects.

Task (yarn or gulp) lists for development build.

Yarn Task	Gulp Task	Description
yarn watch	gulp watch	Watch files for changes and automatically recompile them when it changed.
yarn build	gulp build	Compile sources and copy assets.

Task (yarn or gulp) lists for production build. It will generate minified assets for production deployment.

Yarn Task	Gulp Task	Description
yarn build:prod	gulp build --env=production	Run build task in production environment.

Run Django

First, ensure you are in the correct directory. You should be in either the "full-version" or "starter-kit" folder. Once you are in the appropriate folder, proceed with the following instructions:

1. Create a virtualenv:
Copy

python -m venv .venv

2. Activate the virtualenv you have just created:
• Linux
• MacOS
• Windows

Copy

source .venv/bin/activate

Copy

source .venv/bin/activate

Copy

source .venv/Scripts/activate

3. Install development requirements:
Copy

pip install -r requirements.txt

4. Apply migrations:
Copy

python manage.py migrate

5. Run application through django development server:
Copy

python manage.py runserver

Keep your prompt running by default application is served on http://localhost:8000

To execute the application on a particular IP address(For ex: http://0.0.0.0:8000), include the desired IP address within the `ALLOWED_HOSTS` parameter in the settings.py file.

Copy

python manage.py runserver 0.0.0.0:8000