Serving JavaScript files in Flask - Step-by-Step Execution

Concept Flow - Serving JavaScript files

Client requests HTML page

↓

Flask serves HTML with <script> tag

↓

Browser sees <script src="file.js">

↓

Browser sends request for JS file

↓

Flask serves JS file from static folder

↓

Browser loads and runs JS code

This flow shows how Flask serves JavaScript files by first sending HTML with a script tag, then responding to the browser's request for the JS file from the static folder.

Execution Sample

Flask

from flask import Flask, render_template
app = Flask(__name__)

@app.route('/')
def index():
    return render_template('index.html')

This Flask app serves an HTML page that includes a JavaScript file linked via a script tag.

Execution Table

Step	Action	Request URL	Flask Response	Browser Behavior
1	Client requests '/'	/	Flask returns 'index.html' with <script src='/static/app.js'>	Browser parses HTML, finds script tag
2	Browser requests '/static/app.js'	/static/app.js	Flask serves 'app.js' file from static folder	Browser downloads and executes JS code
3	JS code runs	N/A	N/A	JS modifies page or runs logic as coded
4	No more requests	N/A	N/A	Page fully loaded with JS active

💡 All resources served; browser finishes loading page and scripts.

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
HTML content	None	index.html with <script src='/static/app.js'>	Same	Same	Same
JS file content	None	None	app.js content served	Loaded and executed	Executed
Browser state	Empty	HTML loaded	JS file loaded	JS running	Page interactive

Key Moments - 2 Insights

Why does Flask serve JavaScript files from the 'static' folder?

Flask automatically serves files placed in the 'static' folder at the '/static/' URL path, so JS files must be there to be accessible by the browser as shown in the execution_table step 2.

What happens if the script tag src URL is incorrect?

The browser will request a URL Flask does not serve, resulting in a 404 error and the JS code will not run, breaking the page behavior as seen in execution_table step 2.

Visual Quiz - 3 Questions

Look at the execution table, what does Flask return at step 1?

A The HTML page with a script tag

B The JavaScript file content

C A 404 error

D Nothing

💡 Hint

Check the 'Flask Response' column at step 1 in the execution_table.

At which step does the browser request the JavaScript file?

A Step 1

B Step 3

C Step 2

D Step 4

💡 Hint

Look at the 'Request URL' column in the execution_table to find when '/static/app.js' is requested.

If the JavaScript file was not in the static folder, what would change in the execution table?

A Browser would not request the JS file

B Flask would return a 404 error at step 2

C Flask would serve the JS file anyway

D The HTML page would not load

💡 Hint

Refer to the 'Flask Response' at step 2 and what happens if the file is missing.

Concept Snapshot

Serving JavaScript files in Flask:
- Place JS files in the 'static' folder
- Use <script src='/static/filename.js'> in HTML
- Flask serves static files automatically
- Browser requests JS after loading HTML
- JS runs after being loaded

Full Transcript

When a user visits the Flask app's root URL, Flask sends back an HTML page that includes a script tag pointing to a JavaScript file in the static folder. The browser reads this HTML, then requests the JavaScript file from the '/static/' path. Flask serves this JS file from the static folder. The browser downloads and runs the JavaScript code, making the page interactive. If the JS file is missing or the path is wrong, the browser gets a 404 error and the JS won't run. This process ensures JavaScript files are served correctly alongside HTML in Flask apps.

Practice

1. In Flask, where should you place your JavaScript files so they can be served correctly to the browser?

easy

A. Inside the static folder

B. Inside the templates folder

C. In the root project directory

D. Inside the instance folder

Solution

1. Step 1: Understand Flask static file serving

   Flask automatically serves files placed in the static folder to the browser.

2. Step 2: Identify correct folder for JavaScript files

   JavaScript files must be inside the static folder to be accessible via URL.

3. Final Answer:

   Inside the static folder -> Option A

4. Quick Check:

   Static folder = JavaScript files served [OK]

Hint: Always put JS files in the static folder for Flask to serve them [OK]

Common Mistakes:

• Placing JS files in templates folder
• Putting JS files in root directory
• Expecting instance folder to serve static files

2. Which of the following is the correct way to link a JavaScript file named app.js located in the static folder inside your Flask HTML template?

easy

A. <script src="/templates/app.js"></script>

B. <script src="/static/app.js"></script>

C. <script href="/static/app.js"></script>

D. <link src="/static/app.js">

Solution

1. Step 1: Use correct HTML tag for JavaScript

   The <script> tag with the src attribute is used to link JS files.

2. Step 2: Use correct path to static folder

   Flask serves static files under the /static/ URL prefix, so path should be /static/app.js.

3. Final Answer:

   <script src="/static/app.js"></script> -> Option B

4. Quick Check:

   Script tag + /static path = correct link [OK]

Hint: Use

Common Mistakes:

• Using <link> instead of <script>
• Using href instead of src in <script>
• Linking to /templates folder

3. Given this Flask route and folder structure, what will happen when the browser requests /static/script.js?

app.py:
from flask import Flask
app = Flask(__name__)

@app.route('/')
def home():
    return 'Hello'

Folder structure: - static/ - script.js - app.py

medium

A. The home route will return 'Hello' instead

B. A 404 Not Found error will occur

C. Flask will raise a runtime error

D. The file script.js will be served automatically

Solution

1. Step 1: Understand Flask static file serving default behavior

   Flask automatically serves files inside the static folder at the URL path /static/filename.

2. Step 2: Check if route conflicts with static path

   The / route does not conflict with /static/script.js, so static file is served.

3. Final Answer:

   The file script.js will be served automatically -> Option D

4. Quick Check:

   Static folder files served automatically at /static/ [OK]

Hint: Files in static folder served at /static/filename URL [OK]

Common Mistakes:

• Thinking Flask needs explicit route for static files
• Confusing root route with static file path
• Expecting 404 without static folder

4. You wrote this Flask route to serve a JavaScript file manually:

@app.route('/js/app.js')
def serve_js():
    return open('static/app.js').read()

But the browser shows the JavaScript code as plain text instead of running it. What is the problem?

medium

A. The response is missing the correct Content-Type header for JavaScript

B. The file path 'static/app.js' is incorrect

C. You cannot serve JavaScript files manually in Flask

D. The route path should be '/static/app.js' instead of '/js/app.js'

Solution

1. Step 1: Check how Flask serves static files

   Flask sets the Content-Type header to 'application/javascript' automatically for static files.

2. Step 2: Identify missing Content-Type in manual response

   Returning raw file content without setting Content-Type causes browser to treat it as plain text.

3. Final Answer:

   The response is missing the correct Content-Type header for JavaScript -> Option A

4. Quick Check:

   Set Content-Type to application/javascript for JS files [OK]

Hint: Always set Content-Type header when serving JS manually [OK]

Common Mistakes:

• Not setting Content-Type header
• Assuming Flask auto-sets headers in manual routes
• Using wrong file path without checking

5. You want to serve multiple JavaScript files from a custom folder named assets/js instead of the default static folder. Which Flask code snippet correctly serves these files at URL path /js/<filename>?

hard

A. @app.route('/js/<filename>')
def serve_js(filename):
return open(f'assets/js/{filename}').read()

B. from flask import send_file

@app.route('/js/<filename>')
def serve_js(filename):
return send_file(f'assets/js/{filename}')

C. from flask import send_from_directory

@app.route('/js/<filename>')
def serve_js(filename):
return send_from_directory('assets/js', filename)

D. @app.route('/js/<filename>')
def serve_js(filename):
return redirect(f'/static/{filename}')

Solution

1. Step 1: Use send_from_directory to serve files from custom folder

   Flask's send_from_directory safely serves files from any folder with correct headers.

2. Step 2: Map URL path to custom folder

   The route /js/<filename> calls send_from_directory('assets/js', filename) to serve files from assets/js.

3. Final Answer:

   Use send_from_directory with assets/js folder -> Option C

4. Quick Check:

   send_from_directory + custom folder = correct serving [OK]

Hint: Use send_from_directory to serve files outside static folder [OK]

Common Mistakes:

• Using send_file without setting headers
• Reading file content without headers
• Redirecting to static folder without files there