collectstatic for production in Django - Mini Project: Build & Apply

Collect Static Files for Django Production

📖 Scenario: You are preparing a Django web application to be deployed on a production server. Static files like CSS, JavaScript, and images need to be collected into a single folder so the web server can serve them efficiently.

🎯 Goal: Learn how to configure Django settings and run the collectstatic command to gather all static files into the STATIC_ROOT directory for production use.

📋 What You'll Learn

Create a STATIC_ROOT setting in settings.py with the exact path BASE_DIR / 'staticfiles'

Create a STATIC_URL setting with the exact value '/static/'

Run the collectstatic management command to collect static files

Verify that the collected static files are placed inside the staticfiles directory

💡 Why This Matters

🌍 Real World

Web applications need to serve static files efficiently in production. Collecting static files into one folder helps web servers serve them quickly and reliably.

💼 Career

Knowing how to prepare static files for production is essential for Django developers working on real-world web projects and deployments.

1

Set STATIC_URL in settings.py

In your Django project's settings.py file, create a variable called STATIC_URL and set it to the string '/static/'.

Django

# Your code here

Hint

The STATIC_URL tells Django the base URL to serve static files.

2

Set STATIC_ROOT in settings.py

In settings.py, create a variable called STATIC_ROOT and set it to BASE_DIR / 'staticfiles'. Assume BASE_DIR is already defined as the project base directory.

Django

STATIC_URL = '/static/'
# Your code here

Hint

The STATIC_ROOT is the folder where all static files will be collected for production.

3

Run the collectstatic command

Run the Django management command python manage.py collectstatic in your terminal to collect all static files into the STATIC_ROOT directory.

Django

STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'
# Run collectstatic command in terminal

Hint

This command copies all static files from apps and locations into the staticfiles folder.

4

Verify collected static files in staticfiles folder

Check that the staticfiles directory exists in your project root and contains the collected static files after running collectstatic.

Django

STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'
# Verify staticfiles directory contains collected files

Hint

Use your file explorer or terminal to confirm the staticfiles folder has static assets.

Practice

1. What is the main purpose of running collectstatic in a Django project before deployment?

easy

A. To gather all static files into one folder for easy serving in production

B. To compile Python code into bytecode

C. To migrate database changes

D. To start the Django development server

Solution

1. Step 1: Understand what collectstatic does

   The collectstatic command collects all static files from apps and places them into a single directory.

2. Step 2: Recognize its role in production

   This makes it easier for the web server to serve static files efficiently in production environments.

3. Final Answer:

   To gather all static files into one folder for easy serving in production -> Option A

4. Quick Check:

   collectstatic gathers static files [OK]

Hint: Remember: collectstatic collects static files for production [OK]

Common Mistakes:

• Confusing collectstatic with database migrations
• Thinking collectstatic runs the server
• Assuming collectstatic compiles Python code

2. Which setting must be defined in settings.py to specify where collectstatic will gather static files?

easy

A. STATIC_ROOT

B. MEDIA_ROOT

C. STATIC_URL

D. STATICFILES_DIRS

Solution

1. Step 1: Identify the setting for static file collection

   STATIC_ROOT tells Django the directory where collected static files will be placed.

2. Step 2: Differentiate from other static settings

   STATIC_URL is the URL prefix, MEDIA_ROOT is for user-uploaded files, and STATICFILES_DIRS lists additional static file locations.

3. Final Answer:

   STATIC_ROOT -> Option A

4. Quick Check:

   STATIC_ROOT sets collection folder [OK]

Hint: STATIC_ROOT is the folder for collected static files [OK]

Common Mistakes:

• Confusing STATIC_ROOT with STATIC_URL
• Using MEDIA_ROOT for static files
• Thinking STATICFILES_DIRS is the collection folder

3. Given the following settings.py snippet:

STATIC_URL = '/static/'
STATIC_ROOT = '/var/www/example.com/static/'
STATICFILES_DIRS = ['/home/user/project/assets']

What happens when you run python manage.py collectstatic?

medium

A. Static files are deleted from /var/www/example.com/static/

B. Static files remain in /home/user/project/assets and are not copied

C. Static files from assets and app static folders are copied to /var/www/example.com/static/

D. An error occurs because STATIC_URL is not a valid path

Solution

1. Step 1: Understand the role of STATICFILES_DIRS and STATIC_ROOT

   STATICFILES_DIRS lists extra folders with static files, and STATIC_ROOT is the destination for collected files.

2. Step 2: What collectstatic does

   Running collectstatic copies all static files from app static folders and STATICFILES_DIRS into STATIC_ROOT.

3. Final Answer:

   Static files from assets and app static folders are copied to /var/www/example.com/static/ -> Option C

4. Quick Check:

   collectstatic copies files to STATIC_ROOT [OK]

Hint: collectstatic copies all static files to STATIC_ROOT [OK]

Common Mistakes:

• Thinking STATIC_URL affects file copying
• Believing files stay in source folders
• Assuming collectstatic deletes files

4. You run python manage.py collectstatic but get an error: Permission denied for the STATIC_ROOT directory. What is the best way to fix this?

medium

A. Remove the STATIC_ROOT setting from settings.py

B. Change permissions of the STATIC_ROOT folder to allow write access

C. Run collectstatic without any arguments

D. Delete all static files from your apps

Solution

1. Step 1: Understand the error cause

   The Permission denied error means Django cannot write files to the STATIC_ROOT folder due to OS permissions.

2. Step 2: Fix permissions

   Changing the folder permissions to allow write access for the user running the command resolves this issue.

3. Final Answer:

   Change permissions of the STATIC_ROOT folder to allow write access -> Option B

4. Quick Check:

   Fix permissions to allow writing [OK]

Hint: Fix folder permissions to allow writing [OK]

Common Mistakes:

• Removing STATIC_ROOT disables static collection
• Running collectstatic without fixing permissions
• Deleting static files unnecessarily

5. You want to deploy your Django project to production. Your settings.py has:

STATIC_URL = '/static/'
STATIC_ROOT = '/var/www/example.com/static/'
STATICFILES_DIRS = ['/home/user/project/assets']

After running collectstatic, you notice some static files are missing from /var/www/example.com/static/. What could be a reason and how to fix it?

hard

A. Static files are not copied if DEBUG is True; set DEBUG to False

B. You forgot to set STATIC_URL to the correct path

C. You need to run python manage.py migrate before collectstatic

D. Some static files are inside app folders but not declared in STATICFILES_DIRS; add app static folders or check AppConfig

Solution

1. Step 1: Understand where static files come from

   Django collects static files from app static folders and STATICFILES_DIRS. If files are missing, they might be in app folders not properly recognized.

2. Step 2: Fix by ensuring app static folders are included

   Check that apps have static folders and are correctly configured. Adding missing folders to STATICFILES_DIRS or verifying app configs helps.

3. Final Answer:

   Some static files are inside app folders but not declared in STATICFILES_DIRS; add app static folders or check AppConfig -> Option D

4. Quick Check:

   Missing files often mean missing source folders [OK]

Hint: Check all static source folders are included [OK]

Common Mistakes:

• Thinking STATIC_URL affects file copying
• Running migrate instead of collectstatic
• Assuming DEBUG controls static file copying