STATIC_URL and STATICFILES_DIRS in Django

Introduction

STATIC_URL and STATICFILES_DIRS help Django find and serve your static files like images, CSS, and JavaScript. They make your website look and work nicely.

When you want to add images or styles to your website.

When you have JavaScript files to make your site interactive.

When you want to organize static files in different folders.

When you need Django to know where to find your static files during development.

When you want to serve static files in production after collecting them.

Syntax

Django

STATIC_URL = '/static/'
STATICFILES_DIRS = [
    BASE_DIR / 'static',
]

STATIC_URL is the web address prefix for static files.

STATICFILES_DIRS is a list of folders where Django looks for static files.

Examples

This changes the URL prefix to '/assets/' and tells Django to look in the 'assets' folder for static files.

Django

STATIC_URL = '/assets/'
STATICFILES_DIRS = [
    BASE_DIR / 'assets',
]

Django will look in both 'static' and 'extra_static' folders for static files.

Django

STATIC_URL = '/static/'
STATICFILES_DIRS = [
    BASE_DIR / 'static',
    BASE_DIR / 'extra_static',
]

Sample Program

This example sets up STATIC_URL and STATICFILES_DIRS using BASE_DIR. It prints the URL prefix and the list of folders where Django will look for static files.

Django

from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent

STATIC_URL = '/static/'
STATICFILES_DIRS = [
    BASE_DIR / 'static',
]

print(f"Static URL is: {STATIC_URL}")
print(f"Static files directories: {STATICFILES_DIRS}")

Important Notes

Always end STATIC_URL with a slash '/' to avoid URL problems.

STATICFILES_DIRS is optional if you only use app static folders.

In production, use collectstatic to gather all static files in one place.

Summary

STATIC_URL sets the web path prefix for static files.

STATICFILES_DIRS tells Django where to find extra static files outside apps.

These settings help your website load images, styles, and scripts correctly.

Practice

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

easy

A. It sets the database connection string for static files.

B. It defines the URL prefix to access static files in the browser.

C. It lists the directories where static files are stored on disk.

D. It configures the caching behavior for static files.

Solution

1. Step 1: Understand STATIC_URL role

   STATIC_URL is used to tell Django what URL prefix to use when serving static files like images or CSS.

2. Step 2: Differentiate from STATICFILES_DIRS

   STATICFILES_DIRS lists folders on disk, not URLs. The other options are unrelated to URL prefix.

3. Final Answer:

   It defines the URL prefix to access static files in the browser. -> Option B

4. Quick Check:

   STATIC_URL = URL prefix [OK]

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

Common Mistakes:

• Confusing STATIC_URL with STATICFILES_DIRS
• Thinking STATIC_URL sets file system paths
• Assuming STATIC_URL controls caching

2. Which of the following is the correct way to define STATICFILES_DIRS in Django settings?

easy

A. STATICFILES_DIRS = 'staticfiles'

B. STATICFILES_DIRS = '/static/'

C. STATICFILES_DIRS = [BASE_DIR / 'static']

D. STATICFILES_DIRS = {'static': BASE_DIR}

Solution

1. Step 1: Recognize STATICFILES_DIRS type

   It must be a list or tuple of folder paths, not a string or dict.

2. Step 2: Check syntax correctness

   STATICFILES_DIRS = [BASE_DIR / 'static'] uses a list with a path expression (BASE_DIR / 'static'), which is correct syntax in modern Django.

3. Final Answer:

   STATICFILES_DIRS = [BASE_DIR / 'static'] -> Option C

4. Quick Check:

   STATICFILES_DIRS is a list of folders [OK]

Hint: STATICFILES_DIRS must be a list of folder paths [OK]

Common Mistakes:

• Using a string instead of a list
• Using a dictionary instead of a list
• Forgetting to use BASE_DIR or full path

3. Given the settings:

STATIC_URL = '/assets/'
STATICFILES_DIRS = [BASE_DIR / 'assets']

What URL will Django use to serve a file named logo.png located inside the assets folder?

medium

A. /static/logo.png

B. /static/assets/logo.png

C. /assets/assets/logo.png

D. /assets/logo.png

Solution

1. Step 1: Understand STATIC_URL usage

   STATIC_URL sets the URL prefix for static files. Here it is '/assets/'.

2. Step 2: Map file location to URL

   The file 'logo.png' inside the 'assets' folder will be served at '/assets/logo.png' because STATICFILES_DIRS points to that folder.

3. Final Answer:

   /assets/logo.png -> Option D

4. Quick Check:

   URL = STATIC_URL + filename [OK]

Hint: URL = STATIC_URL + filename path [OK]

Common Mistakes:

• Adding folder name twice in URL
• Using default '/static/' URL instead of custom
• Confusing file system path with URL path

4. You set STATICFILES_DIRS = BASE_DIR / 'static' without brackets in Django settings. What error will occur?

medium

A. TypeError because STATICFILES_DIRS must be a list or tuple

B. No error, it works fine

C. SyntaxError due to missing quotes

D. FileNotFoundError at runtime

Solution

1. Step 1: Check STATICFILES_DIRS expected type

   It must be a list or tuple of paths, not a single path object.

2. Step 2: Analyze given assignment

   Assigning a single path without brackets makes it a path object, not a list, causing a TypeError.

3. Final Answer:

   TypeError because STATICFILES_DIRS must be a list or tuple -> Option A

4. Quick Check:

   STATICFILES_DIRS needs list/tuple [OK]

Hint: Always wrap STATICFILES_DIRS paths in a list or tuple [OK]

Common Mistakes:

• Forgetting brackets around STATICFILES_DIRS paths
• Assuming single path is accepted
• Confusing syntax error with runtime error

5. You want to serve static files from two folders: assets and common_static inside your project. How should you configure STATICFILES_DIRS and STATIC_URL to serve files correctly under the URL prefix /static/?

hard

A. STATIC_URL = '/static/'
STATICFILES_DIRS = [BASE_DIR / 'assets', BASE_DIR / 'common_static']

B. STATIC_URL = '/assets/'
STATICFILES_DIRS = [BASE_DIR / 'static', BASE_DIR / 'common_static']

C. STATIC_URL = '/static/'
STATICFILES_DIRS = BASE_DIR / 'assets' + BASE_DIR / 'common_static'

D. STATIC_URL = '/common_static/'
STATICFILES_DIRS = [BASE_DIR / 'assets']

Solution

1. Step 1: Set STATIC_URL to desired URL prefix

   To serve all static files under '/static/', set STATIC_URL = '/static/'.

2. Step 2: List all static folders in STATICFILES_DIRS

   Include both folders as a list: [BASE_DIR / 'assets', BASE_DIR / 'common_static'] so Django finds files in both.

3. Step 3: Avoid incorrect concatenation or mismatched URLs

   Concatenating paths or mismatching URL prefixes causes errors or missing files.

4. Final Answer:

   STATIC_URL = '/static/' STATICFILES_DIRS = [BASE_DIR / 'assets', BASE_DIR / 'common_static'] -> Option A

5. Quick Check:

   Multiple folders in list, one URL prefix [OK]

Hint: Use list for multiple folders, one STATIC_URL prefix [OK]

Common Mistakes:

• Concatenating paths instead of listing them
• Using different URL prefixes for folders
• Forgetting to include all folders in list