a-r-1 / django-cheatsheet

A compilation of useful code snippets to create, set up, and develop a Django project.

django-cheatsheet

A compilation of useful code snippets to create, set up, and develop a Django project.

Code Of Conduct:

• TBA...

Styling Guidelines:

• TBA...

Requirements:

• Python
• Pip
• Django

Table of Contents

• Installing Django
• Creating a project
• Creating a Django app
• Starting the Server
• Django Models
• Django Views
• URL Patterns
• Rendering a page using views.py
• Creating a Migration
• Applying the Migration

Installing Django

pip install django

Creating a project

django-admin startproject project-name

Starting the Server

python manage.py runserver

Creating an app

python manage.py startapp AppName

Django Models

from django.db import models

class ModelName(models.Model):
ModelName_id = models.AutoField

Django Views

• Views.py

from django.http import HttpResponse

def index(request):
return HttpResponse("cheatsheet")

URL Patterns

from django.contrib import admin
from django.urls import path
from . import views

urlpatterns = [
path('admin/', admin.site.urls),
path('', views.index, name='index'),
path('about/', views.about, name='about'),
path('contact/', views.contact, name='contact'),
]

Render a page using views.py

def index(request):
return render(request, 'index.html')

Creating a migration

python manage.py makemigrations

Applying the migration

python manage.py migrate

Here (TBA)

django-cheatsheet's Issues

Define the structure of the cheetsheet pages

• Add to readme.md and explain how the cheetsheet pages are organised
• Add new blank (empty) cheetsheet pages (including sub-directories, if logical) to the repo

Content - Set up project environment

Installation instructions (if applicable) and commands (if applicable) for the following:

• Describe one or more common tooling sets (e.g. terminal; an IDE (e.g. VS Code))
• Describe one or more ways to create a project environment (e.g. using pipenv; venv; etc.)

N.B. If this content is short => add it to README.md; else => create and add to a new page within the Pages directory.

Create an example page - as a guideline document

• create markdown page titled example-page.md
• add in an example Django code snippet into the page
• include consistent formatting and styling (refer to the readme.md if this section has been updated)

Content - Database migrations

• Add content to show an example model (if one doesn’t already exist)
• (if a new model has been added - reference it in settings.INSTALLED_APPS)
• Show commands to perform database migrations

N.B. If this content is short => add it to README.md; else => create and add to a new page within the Pages directory