Static files in development in Django

Introduction

Static files are images, CSS, and JavaScript that make your website look nice and work well. During development, Django helps you serve these files easily without extra setup.

When you want to add styles to your website using CSS during development.

When you need to include images or icons in your pages while building your app.

When you want to test JavaScript features locally before going live.

When you want to see how your static files affect your site without deploying.

When you want to organize your static files in your Django project for easy access.

Syntax

Django

1. In settings.py, add:

STATIC_URL = '/static/'

2. Place your static files inside an app folder named 'static', e.g., myapp/static/myapp/style.css

3. In your template, load static and use:

{% load static %}
<link rel="stylesheet" href="{% static 'myapp/style.css' %}">

The STATIC_URL setting tells Django where to find static files in URLs.

Use the {% load static %} tag in templates to access static files easily.

Examples

Load an image named logo.png from the static/images folder.

Django

{% load static %}
<img src="{% static 'images/logo.png' %}" alt="Logo">

Include a JavaScript file app.js from the static/js folder.

Django

{% load static %}
<script src="{% static 'js/app.js' %}"></script>

Basic setting to define the URL prefix for static files.

Django

STATIC_URL = '/static/'

Sample Program

This example shows how to set STATIC_URL, organize static files inside an app, and use them in a template. When you run the Django development server, it will serve the CSS file automatically, and the page background will be light blue with a green heading.

Django

# settings.py snippet
STATIC_URL = '/static/'

# Directory structure:
# myproject/
# ├── myapp/
# │   └── static/
# │       └── myapp/
# │           └── style.css
# └── templates/
#     └── base.html

# base.html content:
"""
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <link rel="stylesheet" href="{% static 'myapp/style.css' %}">
  <title>Static Files Demo</title>
</head>
<body>
  <h1>Welcome to Static Files Demo</h1>
</body>
</html>
"""

# style.css content:
"""
body {
  background-color: #e0f7fa;
  font-family: Arial, sans-serif;
}
h1 {
  color: #00796b;
}
"""

Important Notes

During development, Django automatically serves static files if DEBUG = True.

In production, you need a web server or service to serve static files separately.

Keep static files organized inside each app's static folder to avoid conflicts.

Summary

Static files are needed for styling and scripts in your Django app.

Use STATIC_URL and the {% static %} template tag to include them.

Django serves static files automatically during development for easy testing.

Practice

1. What is the purpose of the STATIC_URL setting in a Django project during development?

easy

A. It defines the base URL to access static files like CSS and JavaScript.

B. It specifies the folder where Django stores uploaded media files.

C. It sets the database connection string for static content.

D. It enables automatic caching of static files in production.

Solution

1. Step 1: Understand the role of STATIC_URL

   STATIC_URL tells Django where to find static files when rendering pages, usually a URL prefix like '/static/'.

2. Step 2: Differentiate from other settings

   It is not related to media files, databases, or caching but specifically for static file URLs.

3. Final Answer:

   It defines the base URL to access static files like CSS and JavaScript. -> Option A

4. Quick Check:

   STATIC_URL = base URL for static files [OK]

Hint: STATIC_URL sets the web address prefix for static files [OK]

Common Mistakes:

• Confusing STATIC_URL with media file settings
• Thinking STATIC_URL controls file storage location
• Assuming STATIC_URL manages caching or databases

2. Which of the following is the correct way to include a static CSS file named styles.css in a Django template?

easy

A. <link href="/static/styles.css" rel="stylesheet">

B. <link href="/media/styles.css" rel="stylesheet">

C. <link href="{{ STATIC_URL }}styles.css" rel="stylesheet">

D. <link href="{% static 'styles.css' %}" rel="stylesheet">

Solution

1. Step 1: Use the {% static %} template tag

   In Django templates, static files should be included using the {% static %} tag to generate the correct URL.

2. Step 2: Check syntax correctness

   The correct syntax is <link href="{% static 'filename' %}" rel="stylesheet"> to load static files properly.

3. Final Answer:

   <link href="{% static 'styles.css' %}" rel="stylesheet"> -> Option D

4. Quick Check:

   Use {% static 'file' %} to link static files [OK]

Hint: Use {% static 'file' %} tag inside templates for static files [OK]

Common Mistakes:

• Hardcoding /static/ path without {% static %} tag
• Using {{ STATIC_URL }} which is not available by default
• Confusing media URL with static URL

3. Given the following Django settings and template snippet, what URL will be rendered for the CSS file?

STATIC_URL = '/assets/'

<link href="{% static 'css/main.css' %}" rel="stylesheet">

medium

A. /static/css/main.css

B. /assets/css/main.css

C. /media/css/main.css

D. /css/main.css

Solution

1. Step 1: Check STATIC_URL value

   STATIC_URL is set to '/assets/', so all static file URLs start with this prefix.

2. Step 2: Apply {% static %} tag behavior

   The {% static 'css/main.css' %} tag prepends STATIC_URL to the path, resulting in '/assets/css/main.css'.

3. Final Answer:

   /assets/css/main.css -> Option B

4. Quick Check:

   STATIC_URL + file path = rendered URL [OK]

Hint: STATIC_URL prefix + file path = final static file URL [OK]

Common Mistakes:

• Assuming default '/static/' prefix instead of custom '/assets/'
• Mixing media URL with static URL
• Ignoring STATIC_URL setting in templates

4. You added a static image file and referenced it in your template using {% static 'images/logo.png' %}, but the image does not show during development. Which is the most likely cause?

medium

A. You did not set MEDIA_URL correctly.

B. You forgot to run collectstatic during development.

C. The django.contrib.staticfiles app is not in INSTALLED_APPS.

D. The STATIC_URL setting is missing a trailing slash.

Solution

1. Step 1: Check staticfiles app presence

   Django serves static files in development only if 'django.contrib.staticfiles' is in INSTALLED_APPS.

2. Step 2: Understand collectstatic role

   collectstatic is for production; during development, staticfiles app handles serving automatically.

3. Final Answer:

   The django.contrib.staticfiles app is not in INSTALLED_APPS. -> Option C

4. Quick Check:

   Missing staticfiles app blocks static serving [OK]

Hint: Ensure 'django.contrib.staticfiles' is in INSTALLED_APPS [OK]

Common Mistakes:

• Running collectstatic unnecessarily in development
• Confusing MEDIA_URL with STATIC_URL
• Ignoring INSTALLED_APPS configuration

5. You want to serve static files from a custom folder named assets inside your Django app during development. Which combination of settings and template usage will correctly serve a CSS file assets/css/style.css?

Choose the correct settings and template snippet.

hard

A. In settings.py: STATICFILES_DIRS = [BASE_DIR / 'assets']In template: <link href="{% static 'css/style.css' %}" rel="stylesheet">

B. In settings.py: MEDIA_URL = '/assets/'In template: <link href="{% static 'css/style.css' %}" rel="stylesheet">

C. In settings.py: STATIC_ROOT = 'assets'In template: <link href="/assets/css/style.css" rel="stylesheet">

D. In settings.py: STATICFILES_DIRS = ['assets']In template: <link href="{% static 'css/style.css' %}" rel="stylesheet">

Solution

1. Step 1: Configure STATICFILES_DIRS correctly

   STATICFILES_DIRS should be a list of absolute paths; using BASE_DIR / 'assets' ensures correct path to the assets folder.

2. Step 2: Use {% static %} tag with relative path

   The template should use {% static 'css/style.css' %} to generate the URL, matching the folder structure inside assets.

3. Final Answer:

   In settings.py: STATICFILES_DIRS = [BASE_DIR / 'assets'] and in template: <link href="{% static 'css/style.css' %}" rel="stylesheet"> -> Option A

4. Quick Check:

   STATICFILES_DIRS needs absolute path; use {% static %} for URLs [OK]

Hint: Use absolute path in STATICFILES_DIRS and {% static %} tag [OK]

Common Mistakes:

• Using relative path strings without BASE_DIR
• Confusing STATIC_ROOT with STATICFILES_DIRS
• Setting MEDIA_URL instead of STATICFILES_DIRS