Getting Started
Setup Steex
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.
Prerequisites:
Please follow the below steps to install and setup all prerequisites:
-
Nodejs
Make sure to have Node.js installed & running on your computer. If you already have installed Node on your computer, you can skip this step if your existing node version is greater than 18. We suggest you to use LTS version of Node.js.
-
Yarn
Make sure to have the Yarn installed & running on your computer. If you already have installed Yarn on your computer, you can skip this step. We suggest you use Yarn instead of NPM.
-
Gulp
Make sure to have the Gulp installed & running on your computer. If you already have installed gulp on run command
npm install -g gulp
from your terminal. -
Git
Make sure to have 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
After you finished with the above steps, you can run the following commands into the terminal/command prompt from the root directory ( Steex/admin ) 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
|
Runs the project locally, starts the development server and watches for any changes in your code, including your HTML, Javascript, sass, etc. The development server is accessible at http://localhost:3000. |
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 |
pip3 install django
|
Install Django on linux & mac OS |
pip install django
|
Install Django on Windows OS |
Note:
Depending on your installation, you may need to use
either pip3 or pip and for python you may need to use either python3 or python.
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
pip3 install django-embed-video
pip install django-crispy-forms
pip install django-multiselectfield
pip install social-auth-app-django
pip install crispy-bootstrap5
pip install Pillow
Database Connectivity
Goto settings.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
For Windows: python manage.py migrate
For Linux: 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 Steex/settings.py and add following command:-
STATIC_URL = '/static/'
STATICFILES_DIRS = [os.path.join(BASE_DIR,'static')]
python manage.py collectstatic
SMTP CONFIGURATION
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_PORT = 587
EMAIL_USE_TLS = True
EMAIL_HOST_USER = 'YOUR EMAIL ADDRESS'
EMAIL_HOST_PASSWORD = 'YOUR HOST Password'
DEFAULT_FROM_EMAIL = 'YOUR EMAIL ADDRESS'
Run below command for run your project
For Windows: python manage.py runserver
For Linux: python manage.py runserver