Debug mode in Laravel - Mini Project: Build & Apply

Enable and Use Debug Mode in Laravel

📖 Scenario: You are building a Laravel web application. Sometimes errors happen, and you want to see detailed error messages to fix problems quickly.

🎯 Goal: Learn how to enable Laravel's debug mode and display detailed error information during development.

📋 What You'll Learn

Create a Laravel configuration file change to enable debug mode

Add a helper variable to control debug mode

Use the debug mode setting to conditionally show error details

Complete the setup so Laravel shows detailed error pages when debug mode is on

💡 Why This Matters

🌍 Real World

Developers use debug mode in Laravel to see detailed error messages during development. This helps find and fix bugs faster.

💼 Career

Knowing how to enable and use debug mode is essential for Laravel developers to troubleshoot issues and ensure smooth application development.

1

Set APP_DEBUG to true in .env

Open the .env file and set the variable APP_DEBUG to true exactly like this: APP_DEBUG=true

Laravel

# Open .env file and set APP_DEBUG=true
# Your code here

Hint

Find the line starting with APP_DEBUG= and change its value to true.

2

Create a variable $debug in config/app.php

In the config/app.php file, create a variable called $debug and set it to the value of env('APP_DEBUG', false) exactly like this: $debug = env('APP_DEBUG', false);

Laravel

APP_DEBUG=true

// Create $debug variable to read APP_DEBUG from environment
# Your code here

Hint

Use the env helper to read APP_DEBUG and assign it to $debug.

3

Use $debug to conditionally show error details in a Blade view

In a Blade view file, use an @if directive with the variable $debug to show a message Debug mode is ON only when $debug is true. Write exactly: @if($debug) Debug mode is ON @endif

Laravel

APP_DEBUG=true

$debug = env('APP_DEBUG', false);

{{-- Show debug message if debug mode is on --}}
# Your code here

Hint

Use Blade's @if directive to check $debug and show the message.

4

Complete Laravel debug mode setup to show detailed error pages

Ensure the APP_DEBUG variable is set to true in .env and the $debug variable is used in your app configuration and views so Laravel shows detailed error pages when errors happen.

Laravel

APP_DEBUG=true

$debug = env('APP_DEBUG', false);

@if($debug) Debug mode is ON @endif

// Finalize debug mode setup
# Your code here

Hint

Make sure the environment and config use APP_DEBUG=true and your views check $debug to show debug info.

Practice

1. What does setting APP_DEBUG=true in Laravel's .env file do?

easy

A. Shows detailed error messages to help find bugs

B. Disables all error messages

C. Automatically fixes bugs in the code

D. Prevents the application from running

Solution

1. Step 1: Understand the purpose of APP_DEBUG

   APP_DEBUG controls whether Laravel shows detailed error messages or not.

2. Step 2: Effect of setting APP_DEBUG=true

   When true, Laravel shows detailed error info to help developers find and fix bugs.

3. Final Answer:

   Shows detailed error messages to help find bugs -> Option A

4. Quick Check:

   APP_DEBUG=true means detailed errors shown [OK]

Hint: True means show errors, false hides them [OK]

Common Mistakes:

• Thinking it fixes bugs automatically
• Believing it disables errors
• Confusing it with app running status

2. Which of the following is the correct way to enable debug mode in Laravel?

easy

A. Set APP_DEBUG=false in .env

B. Set APP_DEBUG=true in .env

C. Add debug_mode=on in config/app.php

D. Run php artisan debug:on in terminal

Solution

1. Step 1: Locate where debug mode is set

   Laravel uses the .env file to set environment variables like APP_DEBUG.

2. Step 2: Correct value to enable debug

   Setting APP_DEBUG=true enables debug mode; false disables it.

3. Final Answer:

   Set APP_DEBUG=true in .env -> Option B

4. Quick Check:

   Enable debug by APP_DEBUG=true [OK]

Hint: Enable debug by setting APP_DEBUG=true in .env [OK]

Common Mistakes:

• Setting APP_DEBUG=false to enable debug
• Trying to enable debug in config/app.php
• Using artisan commands that don't exist

3. Given the following .env setting:
APP_DEBUG=false
What will Laravel show when an error occurs?

medium

A. A detailed error page with stack trace

B. The application will crash without any message

C. A simple generic error page without details

D. Laravel will automatically fix the error

Solution

1. Step 1: Check APP_DEBUG value

   APP_DEBUG is set to false, which disables detailed error messages.

2. Step 2: Laravel's behavior with APP_DEBUG=false

   Laravel shows a simple generic error page to avoid exposing sensitive info.

3. Final Answer:

   A simple generic error page without details -> Option C

4. Quick Check:

   APP_DEBUG=false means generic error page [OK]

Hint: False hides details, shows simple error page [OK]

Common Mistakes:

• Expecting detailed errors with APP_DEBUG=false
• Thinking app crashes silently
• Assuming Laravel fixes errors automatically

4. You set APP_DEBUG=true in your .env file but still see a generic error page. What is the most likely cause?

medium

A. You forgot to clear the config cache after changing .env

B. Laravel does not support debug mode

C. APP_DEBUG=true disables error messages

D. Your PHP version is too old

Solution

1. Step 1: Understand config caching in Laravel

   Laravel caches config settings for performance; changes in .env need cache cleared.

2. Step 2: Effect of not clearing cache

   If cache is not cleared, Laravel uses old settings ignoring new APP_DEBUG=true.

3. Final Answer:

   You forgot to clear the config cache after changing .env -> Option A

4. Quick Check:

   Clear config cache to apply .env changes [OK]

Hint: Run php artisan config:clear after .env changes [OK]

Common Mistakes:

• Thinking Laravel lacks debug mode
• Believing APP_DEBUG=true hides errors
• Blaming PHP version without checking

5. You want to safely deploy your Laravel app to production. Which setting for APP_DEBUG should you use and why?

hard

A. APP_DEBUG=true to see errors and fix bugs quickly

B. APP_DEBUG=false to enable automatic bug fixes

C. APP_DEBUG=true to improve app speed

D. APP_DEBUG=false to hide error details from users

Solution

1. Step 1: Understand production environment needs

   In production, showing detailed errors can expose sensitive info to users.

2. Step 2: Choose correct APP_DEBUG setting

   Setting APP_DEBUG=false hides error details, improving security and user experience.

3. Final Answer:

   APP_DEBUG=false to hide error details from users -> Option D

4. Quick Check:

   Production uses APP_DEBUG=false for security [OK]

Hint: Turn off debug in production for security [OK]

Common Mistakes:

• Leaving debug on in production
• Thinking debug improves speed
• Expecting automatic bug fixes