- How do you set up a local testing server?
- Local files vs. remote files
- The problem with testing local files
- Running a simple local HTTP server
- Using an extension in your code editor
- Using Python
- Running server-side languages locally
- Found a content problem with this page?
- Create a Python Web Server
- Example
- Builtin webserver
- Web server
How do you set up a local testing server?
This article explains how to set up a simple local testing server on your machine, and the basics of how to use it.
Prerequisites: | You need to first know how the Internet works, and what a Web server is. |
---|---|
Objective: | You will learn how to set up a local testing server. |
Local files vs. remote files
Throughout most of the learning area, we tell you to just open your examples directly in a browser — this can be done by double-clicking the HTML file, dragging and dropping it into the browser window, or choosing File > Open… and navigating to the HTML file. There are many ways to achieve this.
If the web address path starts with file:// followed by the path to the file on your local hard drive, a local file is being used. In contrast, if you view one of our examples hosted on GitHub (or an example on some other remote server), the web address will start with http:// or https:// , to show that the file has been received via HTTP.
The problem with testing local files
Some examples won’t run if you open them as local files. This can be due to a variety of reasons, the most likely being:
- They feature asynchronous requests. Some browsers (including Chrome) will not run async requests (see Fetching data from the server) if you just run the example from a local file. This is because of security restrictions (for more on web security, read Website security).
- They feature a server-side language. Server-side languages (such as PHP or Python) require a special server to interpret the code and deliver the results.
- They include other files. Browsers commonly treat requests to load resources using the file:// schema as cross-origin requests. So if you load a local file that includes other local files, this may trigger a CORS error.
Running a simple local HTTP server
To get around the problem of async requests, we need to test such examples by running them through a local web server.
Using an extension in your code editor
If you only need HTML, CSS and JavaScript, and no server-side language, the easiest way may be to check for extensions in your code editor. As well as automating installation and set-up for your local HTTP server, they also integrate nicely with your code editors. Testing local files in an HTTP server may be one click away.
For VSCode, you can check the following free extension:
Using Python
Another way to achieve this is to use Python’s http.server module.
Note: Older versions of Python (up to version 2.7) provided a similar module named SimpleHTTPServer . If you are using Python 2.x, you can follow this guide by replacing all uses of http.server with SimpleHTTPServer . However, we recommend you use the latest version of Python.
- Install Python. If you are using Linux or macOS, it should be available on your system already. If you are a Windows user, you can get an installer from the Python homepage and follow the instructions to install it:
- Go to python.org
- Under the Download section, click the link for Python «3.xxx».
- At the bottom of the page, click the Windows Installer link to download the installer file.
- When it has downloaded, run it.
- On the first installer page, make sure you check the «Add Python 3.xxx to PATH» checkbox.
- Click Install, then click Close when the installation has finished.
- Open your command prompt (Windows) / terminal (macOS/ Linux). To check if Python is installed, enter the following command:
-V # If the above fails, try: python3 -V # Or, if the "py" command is available, try: py -V
# include the directory name to enter it, for example cd Desktop # use two dots to jump up one directory level if you need to cd ..
# If Python version returned above is 3.X # On Windows, try "python -m http.server" or "py -3 -m http.server" python3 -m http.server # If Python version returned above is 2.X python -m SimpleHTTPServer
Note: If you already have something running on port 8000, you can choose another port by running the server command followed by an alternative port number, e.g. python3 -m http.server 7800 (Python 3.x) or python -m SimpleHTTPServer 7800 (Python 2.x). You can then access your content at localhost:7800 .
Running server-side languages locally
Python’s http.server (or SimpleHTTPServer for Python 2) module is useful, but it is merely a static file server; it doesn’t know how to run code written in languages such as Python, PHP or JavaScript. To handle them, you’ll need something more — exactly what you’ll need depends on the server-side language you are trying to run. Here are a few examples:
- To run Python server-side code, you’ll need to use a Python web framework. There are many popular Python web frameworks, such as Django (a guide is available), Flask, and Pyramid.
- To run Node.js (JavaScript) server-side code, you’ll need to use raw node or a framework built on top of it. Express is a good choice — see Express Web Framework (Node.js/JavaScript).
- To run PHP server-side code, launch PHP’s built-in development server:
cd path/to/your/php/code php -S localhost:8000
Found a content problem with this page?
This page was last modified on Jul 3, 2023 by MDN contributors.
Create a Python Web Server
A webserver in Python can be setup in two ways. Python supports a webserver out of the box. You can start a web server with a one liner.
But you can also create a custom web server which has unique functionality. In this article you’ll learn how to do that.
The web server in this example can be accessed on your local network only. This can either be localhost or another network host. You could serve it cross location with a vpn.
Example
Builtin webserver
That will open a webserver on port 8080. You can then open your browser at http://127.0.0.1:8080/
The webserver is also accessible over the network using your 192.168.-.- address.
This is a default server that you can use to download files from the machine.
Web server
Run the code below to start a custom web server. To create a custom web server, we need to use the HTTP protocol.
By design the http protocol has a “get” request which returns a file on the server. If the file is found it will return 200.
The server will start at port 8080 and accept default web browser requests.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Python 3 server example
from http.server import BaseHTTPRequestHandler, HTTPServer
import time
hostName = «localhost»
serverPort = 8080
class MyServer(BaseHTTPRequestHandler):
def do_GET(self):
self.send_response(200)
self.send_header(«Content-type», «text/html»)
self.end_headers()
self.wfile.write(bytes(««, «utf-8»))
self.wfile.write(bytes(«
Request: %s
« % self.path, «utf-8»))
self.wfile.write(bytes(««, «utf-8»))
self.wfile.write(bytes(«
This is an example web server.
«, «utf-8»))
self.wfile.write(bytes(««, «utf-8»))
if __name__ == «__main__»:
webServer = HTTPServer((hostName, serverPort), MyServer)
print(«Server started http://%s:%s» % (hostName, serverPort))
try:
webServer.serve_forever()
except KeyboardInterrupt:
pass
webServer.server_close()
print(«Server stopped.»)
If you open an url like http://127.0.0.1/example the method do_GET() is called. We send the webpage manually in this method.
The variable self.path returns the web browser url requested. In this case it would be /example
Python Decorators Introduction