Serving JavaScript files in Flask - Mini Project: Build & Apply

Serving JavaScript Files in Flask

📖 Scenario: You are building a simple Flask web app that needs to serve a JavaScript file to add interactivity on the client side.Think of it like setting up a small shop where you want to display a sign (JavaScript) outside the window (web page) so visitors can see it and interact.

🎯 Goal: Create a Flask app that serves a JavaScript file correctly so the browser can load and run it.

📋 What You'll Learn

Create a Flask app instance named app

Create a route / that returns an HTML page referencing a JavaScript file

Place the JavaScript file in the correct static folder

Serve the JavaScript file using Flask's static file serving

💡 Why This Matters

🌍 Real World

Web developers often need to serve JavaScript files to add interactivity to their web pages. Flask's static folder makes this easy and organized.

💼 Career

Knowing how to serve static files like JavaScript and CSS is essential for backend developers working with Flask or similar web frameworks.

1

Create the Flask app and HTML route

Create a Flask app instance called app and add a route for / that returns a simple HTML string with a <script> tag referencing /static/script.js.

Flask

from flask import Flask

# Create the Flask app instance
# Your code here

Hint

Use Flask(__name__) to create the app. Use @app.route('/') to define the home page. Return an HTML string with a <script> tag linking to /static/script.js.

2

Create the JavaScript file in the static folder

Create a folder named static in your project root. Inside it, create a file named script.js with a single line: console.log('JavaScript loaded');

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return '''Hello from Flask'''

# Create static/script.js file with console.log statement

Hint

The static folder is where Flask looks for static files like JavaScript. Create script.js inside it with the exact console.log line.

3

Run the Flask app with debug mode

Add the code to run the Flask app with debug=True when the script is executed directly.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return '''Hello from Flask'''

# static/script.js file content:
# console.log('JavaScript loaded');

# Add code to run app with debug=True
# Your code here

Hint

Use the standard Python check if __name__ == '__main__': and call app.run(debug=True) inside it.

4

Verify JavaScript is served correctly

Add a comment in the Python file explaining that Flask automatically serves files from the static folder at the /static/ URL path.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return '''Hello from Flask'''

# static/script.js file content:
# console.log('JavaScript loaded');

if __name__ == '__main__':
    app.run(debug=True)

# Add a comment explaining Flask static file serving
# Your code here

Hint

Just add a comment line explaining how Flask serves static files from the static folder.

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