Setup Django
Introduction
We are using gulp which allows having complete automation for build flow. In case if you don't know Gulp then it's easy to use it. Gulp is a toolkit for automating painful or time-consuming tasks in the development workflow, so you can stop messing around while building any project. You can read it more about it here. Please follow below steps to install and setup all prerequisites:
Prerequisites
Please follow below steps to install and setup all prerequisites:
-
Yarn
Make sure to have the Yarn installed & running in your computer. If you already have installed Yarn on your computer, you can skip this step. We suggest you to use Yarn instead of NPM.
-
Nodejs
Make sure to have the Node.js installed & running in your computer. If you already have installed Node on your computer, you can skip this step if your existing node letest version 20.9.0.
-
Gulp
Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on run command
npm install -g gulp
from your terminal. -
Git
Make sure to have the Git installed globally & running on your computer. If you already have installed git on your computer, you can skip this step.
-
Python
Make sure to have the Python installed & running in your computer. If you already have installed Python on your computer, you can skip this step. Please use Python version 3 or if you are using python version 2 then make sure to run all the below commands with python insted of python3.
For windows
- Download python from windows store
- Select the Python's version to download.
- Click on the Install Now
- Installation in Process
For Linux
- sudo apt update
- sudo apt install python3
-
Check Pip version
py -m pip --version
upgread pip
py -m pip install --upgrade pip
-
Virtualenv
Make sure to have the
virtualenv
installed globally & running on your computer. If you already have installed on your computer, you can skip this step.Virtualenv installation command for linux & mac os
python3 -m pip install --user virtualenv
Virtualenv installation command for Windows
py -m pip install --user virtualenv
Installation
To setup the admin theme, follow below-mentioned steps:
-
Install Prerequisites
Make sure to have all above prerequisites installed & running on your computer
After you finished with the above steps, you can run the following commands into the terminal / command prompt from the root directory of the project to run the project locally or build for production use:
Command | Description |
---|---|
yarn install
|
This would install all the required dependencies in
the node_modules folder.
|
gulp
|
It will generate the static folder. |
python3 -m pip install --user virtualenv
|
Create Virtual Environment on linux & mac OS |
py -m pip install --user virtualenv
|
Create Virtual Environment on Windows OS |
source environment_name/bin/activate
|
Activate Environment on Linux & mac OS |
environment_name/Scripts/activate
|
Activate Environment on Windows OS |
python -m pip install Django
|
Install Django on linux & mac OS |
py -m pip install Django
|
Install Django on Windows OS |
-
After you finished with the above steps, you can run the following commands into the terminal / command prompt from the root directory of the project to run the project locally:
-
Install few libraries
pip install django-allauth
pip install django-embed-video
pip install django-crispy-forms
pip install crispy-bootstrap5
-
Database Connectivity
Gotosettings.py
of main directory and update below settings.DATABASES = { 'default': { 'ENGINE': 'django.db.backends.#databaseservername#', 'NAME': 'Your Database Name', 'USER' : 'Database User Name', 'PASSWORD' : 'Your Password', 'HOST' : 'Write down Host', 'PORT' : 'Write down port', } }
-
Run below command for database migration
python manage.py migrate
-
To create a superuser run the below command
python manage.py createsuperuser
enter username Your Username
enter your Email Address
enter your Password
enter your Password again
-
To load static files
Go to Qovex/settings.py and add following command:-
STATIC_URL = '/static/'
STATICFILES_DIRS = [os.path.join(BASE_DIR,'static')]
python manage.py collectstatic
-
Run below command for run your project
python manage.py runserver
Tips
SCSS: We suggest you to do not change any scss files from the src/scss/custom folders because to get new updates will might be break your SCSS changes if any you have made. We strongly suggest you to create new custom.scss file and use that instead of overwrite any theme's custom scss files.