path: root/djangoproject/templates/start.html

{% extends 'base.html' %}
{% load docs i18n %}

{% block layout_class %}full-width{% endblock %}

{% block title %}{% translate "Getting started with Django" %}{% endblock %}

{% block og_title %}{% translate "Getting started with Django" %}{% endblock %}

{% block og_description %}{% translate "It's quick & easy to get up and running with Django" %}{% endblock %}

{% block header %}
  <div class="layout-2col">
    <div class="col two-third">
      <p>{% translate "It’s <em>quick &amp; easy</em> to get up and running with <em>Django</em>." %}</p>
    </div>
    <div class="col one-third last-child">
      <a href="{% url 'download' %}" class="cta">
        {% blocktranslate trimmed %}Download <em>version {{ DJANGO_VERSION }}</em>{% endblocktranslate %}
      </a>
    </div>
  </div>
{% endblock header %}

{% block content %}

  <div class="section">
    <h1>{% translate "Getting started with Django" %}</h1>
    {% url 'document-detail' lang='en' version='stable' url='intro/tutorial01' host 'docs' as tutorial1_url %}
    {% url 'homepage' host 'docs' as docs_homepage_url %}
    <p>
      {% blocktranslate trimmed %}
        Depending how new you are to Django, you can <a href="{{ tutorial1_url }}">try a tutorial</a>, or just
        <a href="{{ docs_homepage_url }}">dive into the documentation</a>.
      {% endblocktranslate %}
    </p>

    <p>
      {% translate "Want to learn more about Django? Read the overview to see whether Django is right for your project." %}
    </p>
    <a class="link-readmore" href="{% url 'overview' %}">{% translate "Django overview" %}</a>
  </div>

  <div class="section">
    <h2>{% translate "Install Django" %}</h2>
    <p>
      {% blocktranslate trimmed %}
        Before you can use Django, you’ll need to install it. Our complete installation guide covers all the
        possibilities; this guide will get you to a simple, minimal installation that’ll work while you walk through
        the introduction.
      {% endblocktranslate %}
    </p>
    <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='intro/install' host 'docs' %}">
      {% translate "Django installation guide" %}
    </a>
  </div>

  <div class="section">
    <h2>{% translate "Write your first Django app" %}</h2>
    <p>
      {% blocktranslate trimmed %}
        Installed Django already? Good. Now <a href="{{ tutorial1_url }}">try this tutorial</a>, which walks you through
        creating a basic poll application. It’s got two parts:
      {% endblocktranslate %}
    </p>
    <ol>
      <li>{% translate "A public site that lets people view polls and vote in them." %}</li>
      <li>{% translate "An administrative interface that lets you add, change and delete polls." %}</li>
    </ol>
    <a class="link-readmore" href="{{ tutorial1_url }}">{% translate "Take the tutorial" %}</a>
  </div>

  <div class="section">
    <h2>{% translate "Sharpen your skills" %}</h2>
    <p>
      {% blocktranslate trimmed %}
        The official <a href="{{ docs_homepage_url }}">Django documentation</a> covers everything you need to know
        about Django (and then some).
      {% endblocktranslate %}
    </p>
    <a href="{{ docs_homepage_url }}" class="link-readmore">{% translate "Read the docs" %}</a>
  </div>

  <div class="section">
    <h2><span>{% translate "Join the community</span>" %}</h2>
      <p>
        {% url 'community-index' as community_index %}
        {% blocktranslate trimmed %}
          You can help <a href="{{ community_index }}">make us better</a>. Find out about upcoming Django events, learn
          what’s on other Django developers’ minds, find and post jobs, and more.
        {% endblocktranslate %}
      </p>
      <a href="{% url 'community-index' %}" class="link-readmore">{% translate "Join us" %}</a>
    </div>

    <div class="list-collapsing-header">
      <h2><span>{% translate "Intro to Django</span>" %}</h2>
      </div>
      <ul class="list-collapsing">
        <li>
          <h2>{% translate "Object-relational mapper" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                Define your data models entirely in Python. You get a rich, dynamic database-access API for free — but you can
                still write SQL if needed.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/db/models' host 'docs' %}">
              {% translate "Read more" %}
            </a>
        {# fmt:off #}
        {% pygment 'python' %}
from django.db import models


class Band(models.Model):
    """A model of a rock band."""

    name = models.CharField(max_length=200)
    can_rock = models.BooleanField(default=True)


class Member(models.Model):
    """A model of a rock band member."""

    name = models.CharField("Member's name", max_length=200)
    instrument = models.CharField(
        choices=(
            ("g", "Guitar"),
            ("b", "Bass"),
            ("d", "Drums"),
        ),
        max_length=1,
    )
    band = models.ForeignKey("Band"){% endpygment %}
        {# fmt:on #}
          </div>
        </li>
        <li>
          <h2>{% translate "URLs and views" %}</h2>
          <div class="collapsing-content">
            <p>A clean, elegant URL scheme is an important detail in a high-quality web application. Django encourages beautiful URL design and doesn’t put any cruft in URLs, like .php or .asp.</p>
            <p>To design URLs for an application, you create a Python module called a URLconf. Like a table of contents for your app, it contains a simple mapping between URL patterns and your views.</p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/http/urls' host 'docs' %}">Read more</a>
        {# fmt:off #}
        {% pygment 'python' %}
from django.urls import path

from . import views

urlpatterns = [
    path("bands/", views.band_listing, name="band-list"),
    path("bands/<int:band_id>/", views.band_detail, name="band-detail"),
    path("bands/search/", views.band_search, name="band-search"),
]{% endpygment %}
        {% pygment 'python' %}
from bands.models import Band
from django.shortcuts import render


def band_listing(request):
    """A view of all bands."""
    bands = Band.objects.all()
    return render(request, "bands/band_listing.html", {"bands": bands}){% endpygment %}
        {# fmt:on #}
          </div>
        </li>
        <li>
          <h2>{% translate "Templates" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                Django’s template language is designed to strike a balance between power and ease. It’s designed to feel
                comfortable and easy-to-learn to those used to working with HTML, like designers and front-end developers.
                But it is also flexible and highly extensible, allowing developers to augment the template language as needed.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/templates' host 'docs' %}">Read more</a>
      {# No need to escape the HTML: pygment takes care of that #}
            {% pygment 'django' %}
{% verbatim %}
<html>
  <head>
    <title>{% translate "Band Listing" %}</title>
  </head>
  <body>
    <h1>{% translate "All Bands" %}</h1>
    <ul>
    {% for band in bands %}
      <li>
        <h2><a href="{{ band.get_absolute_url }}">{{ band.name }}</a></h2>
        {% if band.can_rock %}<p>{% translate "This band can rock!" %}</p>{% endif %}
      </li>
    {% endfor %}
    </ul>
  </body>
</html>{% endverbatim %}{% endpygment %}
          </div>
        </li>
        <li>
          <h2>{% translate "Forms" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                Django provides a powerful form library that handles rendering forms as HTML, validating user-submitted data,
                and converting that data to native Python types. Django also provides a way to generate forms from your
                existing models and use those forms to create and update data.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/forms' host 'docs' %}">Read more</a>
        {# fmt:off #}
        {% pygment 'python' %}
from django import forms


class BandContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.TextField()
    sender = forms.EmailField()
    cc_myself = forms.BooleanField(required=False){% endpygment %}
        {# fmt:on #}
          </div>
        </li>
        <li>
          <h2>{% translate "Authentication" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                Django comes with a full-featured and secure authentication system. It handles user accounts, groups,
                permissions and cookie-based user sessions. This lets you easily build sites that allow users to create
                accounts and safely log in/out.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/auth' host 'docs' %}">{% translate "Read more" %}</a>
        {# fmt:off #}
        {% pygment 'python' %}
from django.contrib.auth.decorators import login_required
from django.shortcuts import render


@login_required
def my_protected_view(request):
    """A view that can only be accessed by logged-in users"""
    return render(request, "protected.html", {"current_user": request.user}){% endpygment %}
        {# fmt:on #}
          </div>
        </li>
        <li>
          <h2>{% translate "Admin" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                One of the most powerful parts of Django is its automatic admin interface. It reads metadata in your
                models to provide a powerful and production-ready interface that content producers can immediately
                use to start managing content on your site. It’s easy to set up and provides many hooks for customization.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='ref/contrib/admin' host 'docs' %}">{% translate "Read more" %}</a>
        {# fmt:off #}
        {% pygment 'python' %}
from bands.models import Band, Member
from django.contrib import admin


class MemberAdmin(admin.ModelAdmin):
    """Customize the look of the auto-generated admin for the Member model"""

    list_display = ("name", "instrument")
    list_filter = ("band",)

    admin.site.register(Band)  # Use the default options
    admin.site.register(Member, MemberAdmin)  # Use the customized options{% endpygment %}
        {# fmt:on #}
          </div>
        </li>
        <li>
          <h2>{% translate "Internationalization" %}</h2>
          <div class="collapsing-content">
            <p>
              {% blocktranslate trimmed %}
                Django offers full support for translating text into different languages, plus locale-specific formatting
                of dates, times, numbers, and time zones. It lets developers and template authors specify which parts of
                their apps should be translated or formatted for local languages and cultures, and it uses these hooks
                to localize web applications for particular users according to their preferences.
              {% endblocktranslate %}
            </p>
            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/i18n' host 'docs' %}">{% translate "Read more" %}</a>
        {# fmt:off #}
        {% pygment 'python' %}
from django.shortcuts import render
from django.utils.translation import gettext


def homepage(request):
    """
    Shows the homepage with a welcome message that is translated in the
    user's language.
    """
    message = gettext("Welcome to our site!")
    return render(request, "homepage.html", {"message": message}){% endpygment %}
        {# fmt:on #}
      {# No need to escape the HTML: pygment takes care of that #}
            {% pygment 'django' %}
{% verbatim %}
{% load i18n %}
<html>
  <head>
    <title>{% translate "Homepage - Hall of Fame" %}</title>
  </head>
  <body>
    {# Translated in the view: #}
    <h1>{{ message }}</h1>
    <p>
      {% blocktranslate count member_count=bands.count %}
        Here is the only band in the hall of fame:
      {% plural %}
        Here are all the {{ member_count }} bands in the hall of fame:
      {% endblocktranslate %}
    </p>
    <ul>
    {% for band in bands %}
      <li>
        <h2><a href="{{ band.get_absolute_url }}">{{ band.name }}</a></h2>
        {% if band.can_rock %}<p>{% translate 'This band can rock!' %}</p>{% endif %}
      </li>
    {% endfor %}
    </ul>
  </body>
</html>{% endverbatim %}{% endpygment %}
          </div>
        </li>
        <li>
          <h2>{% translate "Security" %}</h2>
          <div class="collapsing-content">
            <p>{% translate "Django provides multiple protections against:" %}</p>
            <ul>
              <li>{% translate "Clickjacking" %}</li>
              <li>{% translate "Cross-site scripting" %}</li>
              <li>{% translate "Cross Site Request Forgery (CSRF)" %}</li>
              <li>{% translate "SQL injection" %}</li>
              <li>{% translate "Remote code execution" %}</li>
            </ul>

            <a class="link-readmore" href="{% url 'document-detail' lang='en' version='stable' url='topics/security' host 'docs' %}">{% translate "Read more" %}</a>

          </div>
        </li>
      </ul>

{% endblock content %}