Django project structure walkthrough

Introduction

Django project structure helps organize your web app files clearly. It makes your code easy to find and manage.

When starting a new Django web application.

When you want to understand where to put your code and templates.

When you need to add new features like apps or static files.

When debugging or updating your Django project.

When collaborating with others on a Django project.

Syntax

Django

myproject/          # Root folder of your project
  manage.py          # Command-line tool to run tasks
  myproject/         # Main project folder
    __init__.py      # Marks this as a Python package
    settings.py      # Configuration settings
    urls.py          # URL routing for the project
    asgi.py          # ASGI server entry point
    wsgi.py          # WSGI server entry point
  app1/              # A Django app folder
    migrations/      # Database migrations
    __init__.py
    admin.py         # Admin site settings
    apps.py          # App configuration
    models.py        # Data models
    tests.py         # Tests for app
    views.py         # Views (logic for pages)
  templates/         # HTML templates
  static/            # Static files like CSS, JS, images

The manage.py file helps you run commands like starting the server or making migrations.

Each app is a smaller part of your project that does one job, like handling users or blog posts.

Examples

This shows a project with one app called blog. Templates for the blog are inside the app folder.

Django

myproject/
  manage.py
  myproject/
    settings.py
    urls.py
  blog/
    models.py
    views.py
    templates/
      blog/
        post_list.html

Here, static files like CSS are stored in a separate static folder at the project root.

Django

myproject/
  manage.py
  myproject/
    settings.py
    urls.py
  users/
    models.py
    views.py
  static/
    css/
      style.css

Sample Program

This is a simple Django project with one app called polls. It has folders for templates and static files outside the app folder for shared use.

Django

myproject/
  manage.py
  myproject/
    __init__.py
    settings.py
    urls.py
    asgi.py
    wsgi.py
  polls/
    __init__.py
    admin.py
    apps.py
    migrations/
      __init__.py
    models.py
    tests.py
    views.py
  templates/
    base.html
  static/
    css/
      main.css

Important Notes

Always keep your apps focused on one task to keep your project organized.

Use the templates folder for HTML files and static for CSS, JavaScript, and images.

Remember to add your apps to INSTALLED_APPS in settings.py to activate them.

Summary

Django projects have a clear folder structure to organize code and files.

manage.py helps run commands for your project.

Apps are smaller parts of the project, each with its own files.

Practice

1. Which file in a Django project is used to run commands like starting the server or creating migrations?

easy

A. manage.py

B. settings.py

C. urls.py

D. wsgi.py

Solution

1. Step 1: Identify the command runner file

   The manage.py file is designed to run commands like starting the server or making migrations.

2. Step 2: Understand other files' roles

   settings.py holds configuration, urls.py routes URLs, and wsgi.py is for deployment interface.

3. Final Answer:

   manage.py -> Option A

4. Quick Check:

   Command runner = manage.py [OK]

Hint: Remember: manage.py runs commands for your project [OK]

Common Mistakes:

• Confusing settings.py as command runner
• Thinking urls.py runs commands
• Assuming wsgi.py runs server commands

2. Which folder typically contains the settings and URL configuration files in a Django project?

easy

A. The app folder

B. The templates folder

C. The project folder

D. The static folder

Solution

1. Step 1: Identify where settings.py and urls.py live

   These files are inside the main project folder, which shares the project name.

2. Step 2: Differentiate folders

   App folders contain app-specific code, templates hold HTML files, static holds CSS/JS/images.

3. Final Answer:

   The project folder -> Option C

4. Quick Check:

   Settings and URLs = project folder [OK]

Hint: Settings and URLs live in the project folder, not apps [OK]

Common Mistakes:

• Thinking settings.py is inside an app folder
• Confusing templates folder with project folder
• Assuming static folder holds config files

3. Given this Django project structure snippet:

myproject/
  manage.py
  myproject/
    settings.py
    urls.py
  blog/
    models.py
    views.py
    urls.py

Which file would you edit to add a new URL route for the blog app?

medium

A. myproject/settings.py

B. blog/urls.py

C. myproject/urls.py

D. manage.py

Solution

1. Step 1: Understand URL routing in Django

   The main project urls.py includes app URLs, but app-specific routes go in the app's urls.py.

2. Step 2: Locate where to add blog routes

   To add blog-specific URLs, edit blog/urls.py where blog views are connected to paths.

3. Final Answer:

   blog/urls.py -> Option B

4. Quick Check:

   App URLs go in app's urls.py [OK]

Hint: Add app URLs inside the app's own urls.py file [OK]

Common Mistakes:

• Adding app URLs directly in project urls.py
• Editing settings.py for URL routes
• Trying to add routes in manage.py

4. You try to run your Django project but get an error: ModuleNotFoundError: No module named 'blog'. Which of these is the most likely cause?

medium

A. You forgot to import models.py in views.py

B. You did not create a urls.py file in the blog app

C. You ran manage.py from the wrong folder

D. You forgot to add the blog app to INSTALLED_APPS in settings.py

Solution

1. Step 1: Understand the error meaning

   The error means Python cannot find the blog app module when loading the project.

2. Step 2: Check common causes

   Not adding the app name to INSTALLED_APPS in settings.py causes this error because Django doesn't recognize the app.

3. Final Answer:

   Forgot to add blog to INSTALLED_APPS -> Option D

4. Quick Check:

   Missing app in INSTALLED_APPS = ModuleNotFoundError [OK]

Hint: Always add new apps to INSTALLED_APPS in settings.py [OK]

Common Mistakes:

• Assuming missing urls.py causes ModuleNotFoundError
• Running manage.py from wrong folder usually gives different error
• Forgetting imports in views.py causes different errors

5. You want to create a new Django app called shop inside your project. Which sequence of actions correctly follows Django project structure best practices?

hard

A. Run python manage.py startapp shop, then add shop to INSTALLED_APPS in settings.py

B. Create a folder named shop manually, then add shop to urls.py

C. Add shop to INSTALLED_APPS first, then run python manage.py startapp shop

D. Run python manage.py startproject shop inside your project folder

Solution

1. Step 1: Create the app properly

   Use python manage.py startapp shop to create the app folder with correct files.

2. Step 2: Register the app in settings

   Add shop to INSTALLED_APPS in settings.py so Django knows about it.

3. Final Answer:

   Run startapp then add to INSTALLED_APPS -> Option A

4. Quick Check:

   Start app then register in settings [OK]

Hint: Always start app with manage.py then add to INSTALLED_APPS [OK]

Common Mistakes:

• Manually creating app folder misses essential files
• Adding app to INSTALLED_APPS before creating it
• Using startproject instead of startapp for apps