Installation
Note: Jidox offers enhanced real-time customization of your layout through the use of CSS variables, which are set via Sass. If you want to take full advantage of Jidox's customization options, we recommend following the setup steps below to install Node.js and Gulp and build your own version of the template.
We utilize Gulp to automate our build flow, allowing for complete automation of our development workflows. Gulp is a powerful toolkit designed to help developers eliminate time-consuming tasks, allowing them to focus on what really matters: building great products. If you're not familiar with Gulp, you can learn more about it here.
Prerequisites
To get started with Jidox, please follow the steps below to install and set up all the necessary prerequisites:
-
Nodejs
Make sure to have the Node.js installed & running in your computer. If you already have installed nodejs on your computer, you can skip this step.
-
Yarn
Ensure that you have Yarn installed and running on your computer. If you already have Yarn installed, you can skip this step.
-
Gulp & Gulp CLI
Ensure that you have Gulp installed and running on your computer. If you already have Gulp installed, you can skip this step. If not, you can install it by running the following command from your terminal:
npm install -g gulp
. -
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
-
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
After you finished with above steps, you can run the following commands to run project locally or build for production use:
Command | Description |
---|---|
yarn install
|
This would install all the required dependencies in the
node_modules folder.
|
gulp
|
This will compile all the static assets and watch out for any changes. If you would
like to simply make production ready build, use the command gulp build .
|
python -m venv environment_name
|
Create Virtual Environment on linux & mac OS |
python -m venv environment_name
|
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 |
pip install -r requirements.txt
|
This would install all the required python dependencies. |
python manage.py migrate
|
It will create the migration table in a database. |
python manage.py createsuperuser
|
It will create superuser. (Note:After creating a superuser, if you want to log in with that credentials then have to make your registered email verified at the admin panel or you can log in with the default user.) |
python manage.py runserver
|
It starts development server on localhost:8000. |