Prerequisites

Please follow below steps to install and setup all prerequisites:

• Node.js

  In order to use build tools you will need to download and install Node.js. If you do not have Node.js installed already, you can get it by downloading the package installer from the official website. Please download the stable version of Node.js (LTS).

• Gulp & Gulp CLI

  Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on your computer, you can skip this step. In order to install, just run command npm install -g gulp@4.0.1 from your terminal.

• 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.

  For Windows

  • Download python from windows store.
  • Select the Python's latest version to download.

  For Linux

  • sudo apt update
  • sudo apt install python3

• 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.

  For Windows

  • py -m pip install --user virtualenv

  For Linux

  • python3 -m pip install --user virtualenv

Installation

You can run this app using one of these package managers Yarn, NPM.

Command	Description
yarn	This would install all required dependencies in node_modules folder.
yarn dev or gulp	This would compile plugin, scss and generates css in assets folder.
yarn build or gulp build	It compiles the source assets including scss and bundles into production ready use.
yarn rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
yarn rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

Command	Description
npm i or npm i --force	This would install all required dependencies in node_modules folder.
npm run dev or gulp	This would compile all the resources from assets folder to assets folder.
npm run build or gulp build	It compiles the source assets including scss and bundles into production ready use.
npm run rtl or gulp rtl	This would compile plugin, scss and generates rtl css in assets folder.
npm run rtl-build or gulp rtlBuild	It compiles the source assets including scss and bundles into production ready use RTL

To spin up the Django development server, follow the below mentioned steps in a separate terminal:

Command	Description
python3 -m venv environment_name	Create Virtual Environment on Linux & macOS
python -m venv environment_name	Create Virtual Environment on Windows OS
source environment_name/bin/activate	Activate Environment on Linux & macOS
environment_name/Scripts/activate	Activate Environment on Windows OS
pip install -r requirements.txt	This would install all the required python dependencies
cp env.sample .env	Create .env from env.sample file.
(Linux/Mac): export FLASK_APP=run.py (Windows): set FLASK_APP=run.py (Powershell): $env:FLASK_APP = ".\run.py"	Set the FLASK_APP environment variable
(Linux/Mac): export FLASK_ENV=development (Windows): set FLASK_ENV=development (Powershell): $env:FLASK_ENV = "development"	Set up the DEBUG environment
flask run	Runs the project locally, starting the development server on http://127.0.0.1:5000.