Skip to content

Latest commit

 

History

History
245 lines (198 loc) · 7.25 KB

new_blank_website.md

File metadata and controls

245 lines (198 loc) · 7.25 KB
Raw

Django website creation

❶ Ensure that the Python version installed with Miniconda is greater than 3.9 by running the following command in the Anaconda Prompt (recommended) or cmd:

python --version

❷ Install Django using pip and verify the version:

pip install django django-browser-reload crispy-bootstrap5

and then check the version using the following command:

django-admin --version

Make sure the Django version is 5 or higher.

❸ Open Anaconda Prompt and navigate to the Documents folder:

cd Documents
Create a blank directory:

(dont copy the following code, its just an syntax example:)

mkdir <my_django_project>
cd <my_django_project>

Replace <my_django_project> with the project name example:

mkdir blog_website
cd blog_website

❹ Launch VSCode using the following command:

code .

If the above command doesn't work, manually open VSCode and then open the folder my_django_project.

❺ Config VSCode

Check if the Python extension is installed in VSCode by navigating to the Extensions view (Ctrl+Shift+X) and searching for "Python".

Press Ctrl+Shift+P to open the command palette and search for "Python: Select Interpreter". Choose the Python interpreter with version 3.9 or higher (miniconda).

Switch to the command prompt terminal in VSCode, as PowerShell sometimes doesn't work well with Python environments.

❻ Create the Django project folder using the following command:

django-admin startproject config .

This command creates a Django project named config in the current directory (.).

❼ Create the necessary folders for your project structure:

mkdir templates
cd templates

mkdir layout components

cd ..

mkdir assets

cd assets

mkdir css js images videos fonts

cd ..

Explanation:

  • mkdir templates: Creates a directory named 'templates' in the current location.
  • cd templates: Changes the current directory to 'templates'.
  • mkdir base components: Creates two directories named 'base' and 'components' inside the 'templates' directory.
  • cd ..: Moves one directory up (back to the parent directory).
  • mkdir assets: Creates a directory named 'assets' in the current location.
  • cd assets: Changes the current directory to 'assets'.
  • mkdir css js images videos fonts: Creates five directories named 'css', 'js', 'images', 'videos', and 'fonts' inside the 'assets' directory.
  • cd ..: Moves one directory up (back to the parent directory).

❽ Open settings.py file located in the config folder and make the following changes:

set the templates directory in TEMPLATES section
# settings.py
...
TEMPLATES = [
    {
        ...
        'DIRS': [BASE_DIR.joinpath('templates')], # this line only
        ...
    },
]
...
Fix the timezone to your country (for my brilliant students, jo h likha usko hata ke likhna h)
TIME_ZONE = 'Asia/Kolkata'
Update the static files section with assets and media
STATIC_URL = 'static/'
STATICFILES_DIRS = [BASE_DIR.joinpath('assets')]
STATIC_ROOT = BASE_DIR.joinpath('staticfiles')

MEDIA_URL = 'media/'
MEDIA_ROOT = BASE_DIR.joinpath('media')

Explanation:

TEMPLATES Configuration:

  • Specifies the directory for template files. Utilizes BASE_DIR.joinpath('templates') to locate the 'templates' directory within the project's base directory. TIME_ZONE Configuration:

  • Sets the default time zone to 'Asia/Kolkata'. STATIC_URL Configuration:

  • Defines the URL prefix for serving static files. STATICFILES_DIRS Configuration:

  • Lists additional directories for serving static files. STATIC_ROOT Configuration:

  • Specifies the directory where collected static files will be stored during deployment. MEDIA_URL Configuration:

  • Sets the URL prefix for serving media files. MEDIA_ROOT Configuration:

  • Defines the directory where uploaded media files will be stored.

Optional - MySQL database configuration

❾ Inside settings.py, update the database settings to use MySQL and install the required libraries:

Install MySQL server & configure it

open mysql command line client and create your project database

CREATE DATABASE IF NOT EXISTS <db_name>;
SHOW DATABASES;
Install MySQL client using the terminal in vscode
pip install mysqlclient
Update the DATABASES configuration:
# settings.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'your_database_name',
        'USER': 'your_database_user',
        'PASSWORD': 'your_database_password',
        'HOST': 'localhost',
        'PORT': '3306',
    }
}

  • DATABASES Configuration:

    • Configures the database connection for the project using a dictionary.
    • The 'default' key specifies the default database connection.

  • ENGINE Configuration:

    • Defines the database engine to be used, set to 'django.db.backends.mysql' indicating MySQL database backend.

  • NAME, USER, PASSWORD, HOST, and PORT Configuration:

    • Specifies the database name, username, password, host, and port respectively.
    • These values should be replaced with appropriate credentials for the MySQL database.

  • Connection Details:

    • Establishes a connection to a MySQL database named 'your_database_name' hosted on 'localhost' with port '3306'.
    • Utilizes provided username and password for authentication.

  • Purpose:

    • Enables Django to interact with the MySQL database for storing and retrieving data required by the web application.

Important

❿ Update the urls.py file located in the config folder:

# urls.py
from django.contrib import admin
from django.urls import path, include
from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    path('admin/', admin.site.urls),
    ...
]

if settings.DEBUG:
    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
    urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

Explanation:

  • urlpatterns Configuration:
    • Specifies the URL patterns for the web application.
    • Includes the default URL pattern for the Django admin site.
  • if settings.DEBUG Configuration:
    • Checks if the application is running in debug mode.
    • If true, appends URL patterns for serving media and static files during development.
  • Purpose:
    • Enables the web application to serve media and static files when running in debug mode.

🥳 You have successfully set up a Django project on Windows

⓫ Run the following command in the terminal to check if the project runs:

python manage.py runserver

3rd party plugins

created by team digipodium with ❤️ & python