Thank you very much for your purchase!

If you have any questions that are beyond the scope of this documentation, please feel free to email or contact us via my page.

Support Email: support@pichforest.com

Installation

The zip file contains all js files integrated with Xegal, however you need to perform following steps to run project locally.

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. If you are using Windows OS then please install using APP store.

Prerequisites

Please follow below steps to install and setup all prerequisites:

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

    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

    For windows
      py -m pip --version
      upgrade pip
      py -m pip install --upgrade pip
    For Linux
      python -m pip --version
      upgrade pip
      python -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
  • Install Prerequisites

    Make sure to have all above prerequisites installed & running on your computer

Command Description
python3 -m venv env_name Create Virtual Environment on linux & mac OS
python -m venv env_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
  • Install Flask
    pip install flask

  • Install Libraries
    pip install SQLAlchemy
    pip install flask_sqlalchemy
    pip install flask-wtf
    pip install Flask-Mail

  • SMTP CONFIGURATION

    Go to Xegal/xegal.py and update credential

    xegal.config.update(
    MAIL_SERVER = 'smtp.gmail.com',
    MAIL_PORT = 465,
    MAIL_USE_SSL = True,
    MAIL_USERNAME = 'YOUR EMAIL ADDRESS',
    MAIL_PASSWORD = 'YOUR EMAIL PASSWORD',
    MAIL_DEFAULT_SENDER = 'YOUR EMAIL ADDRESS'
    )

  • Run Project
    1) python xegal.py
    2) flask run

Structure

I have tried my best to have standards and modular structure while developing the theme. Following sections are explaining the theme File & Folder, Structure, CSS, js files Structure and plugins.

File & Folder Structure

Root Directory
├── Xegal
	├── __pycache__
	├── static
		└── css	
		├── fonts
		├── images
		└── js											
	├── templates
		├── index
		├── partials
	└── xegal.db
	└── xegal.py

Set Default home page

1) Index 1

Go to Xegal/xegal.py.
and update code return render_template('index/index-1.html') at line number 39.

2) Index 2

Go to Xegal/xegal.py.
and update code return render_template('index/index-2.html') at line number 39.

3) Index 3

Go to Xegal/xegal.py.
and update code return render_template('index/index-3.html') at line number 39.

4) Index 4

Go to Xegal/xegal.py.
and update code return render_template('index/index-4.html') at line number 39.

5) Index 5

Go to Xegal/xegal.py.
and update code return render_template('index/index-5.html') at line number 39.

6) Index 6

Go to Xegal/xegal.py.
and update code return render_template('index/index-6.html') at line number 39.

Support

Once again thank you for purchasing the theme. I am always avaialble to help you. If you have any suggestion or feature to make it more better, I am requesting you to contact me, I'll try my best to add them in future updates.

Best,

- Pichforest

Copyright 2021 Pichforest.