Django-Project-Template

A small starter Django's Skeleton Project with all settings already set.

This project contains:

• Extended User Structure
• Login / Logout
• Profile editing (to be fixed)
• django-info (corresponding to PHPInfo)
• A small About that display the licence (or whatever you want)
• An example og UI with toolbar and searchbar
• Custom Error Handlers for 500 and 400
• All Settings already configured for static path like Avatar and use uploaded files

How to use this template

  # Create et access project folder
  mkdir project_name
  cd project_name
  wget https://github.com/apressato/Django-Project-Template/archive/refs/heads/master.zip

  # Create Python virtual env 
  python3 -m venv .venv

  # Activate virtual env
  source .venv/bin/activate

  # Upgrade pip
  python -m pip install --upgrade pip

  # Install all requirements
  python -m pip install -r @requirements.txt

  # Create Django Project
  django-admin startproject project_name  

Extract the file unzipgithubhelper.py from master.zip then execute the command below:

  # Extract template
  python .\unzipgithubhelper.py -f .\master.zip -o .\ -p {your project name} 

  # Clean folder
  del master.zip

  # Generate migration files
  python -m manage makemigrations

  # Apply Migration file 
  python -m manage migrate

  # Create Super User
  python -m createsuperuser

  # Download Free version of Material Design Bootstrap UI Kit
  wget https://github.com/mdbootstrap/mdb-ui-kit/archive/refs/heads/master.zip
  # Extract UI KIT
  python .\unzipgithubhelper.py -f .\master.zip -o /static/MDB5UIKIT

You can add more functions to your site by using the Django command startapp:

  .venv/script/activate

  # Create App
  python manage.py startapp app_name

don't forget to add the new function in settings.py

# Application definition
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    ...,
    'app_name',
]