Ubyssey Code
Search…
Intro to Backend Dev
What is backend development?
Web development is often split into two categories: backend and frontend. It's easy for beginners to get confused between the two, especially because there is often some overlap.
Backend development involves writing code and processes that run only on a web server, whereas frontend code runs in the user's web browser.
Frontend code is publicly visible and includes a website's HTML, CSS and JavaScript resources, while backend code is almost always hidden from the user. Some examples of backend tasks include:
- Fetching and preparing data from a database
- Authenticating a user when they log into a secure system
- Performing complex calculations or CPU-intensive tasks
Due to security and performance reasons, it's easy to see why these tasks shouldn't happen on the user's device.
What does a newspaper backend look like?
The backend code for ubyssey.ca is mainly concerned with fetching data from a database (usually news articles), preparing the data and sending it back to the user. This process looks something like this:
- 1.
- 2.The web server receives the request and parses any relevant information (e.g. the article slug "max-holmes-wins-vp-academic")
- 3.The server then loads the article data from the database
- 4.After loading the data, it is converted into an HTML document that is returned to the user's web browser
The rest of this tutorial will be covering the above steps in more detail.
Introducing Python
The backend code for ubyssey.ca is written in the Python programming language. We choose to use Python for several reasons, the main one being that its fairly easy to learn and many people are already familiar with it. More specifically, our platform is built on top of the popular Django web framework, so much of the heavy lifting (routing, authentication, database access) is already handled for us.
If you want to learn more about Python, check out the resources page. However, this tutorial is designed for beginners who have never used Python before.
1. URL Routing
A Universal Resource Locator (URL), often called a web address, is what a web browsers uses to access resources stored on a web server. Think of it like a mailing address for a web page. The first part of a URL, called the hostname (e.g. ww.ubyssey.ca), is converted to an IP address (e.g. 216.239.32.21) through something called a DNS lookup, which tells the browser which server to send the request to. The server is then responsible for "routing" the remaining portion of the URL (e.g. /news/max-holmes-wins-vp-academic/), which is often the first task that a web backend must take care of.
A web server should be able to understand the structure of a URL and send incoming requests to the right place. If the server can't understand the URL or if the URL is invalid, a proper error message should be returned.
Luckily for us, Django has a set of tools that make this process relatively straightforward. We simply tell Django the structure of a URL and it will route incoming requests to functions that we define. For this tutorial, we'll be focusing on the homepage, which happens to have the simplest URL pattern:
1
# ubyssey/urls.py
2
​
3
from django.conf.urls import url
4
​
5
theme = UbysseyTheme()
6
​
7
urlpatterns = [
8
url(r'^#x27;, theme.home),
9
​
10
# More patterns below...
11
]
Copied!
URL patterns are defined using regular expressions, which give us a way to match multiple strings against a defined structure. For example, here's the pattern for article URLs, which always contain a section name, followed by a slash, and then the article slug:
1
url(r'^(?P<section>[-\w]+)/(?P<slug>[-\w]+)/#x27;, theme.article)
2
​
3
'/news/max-holmes-wins-vp-academic/' # Match
4
'/sports/fall-softball-classic-2017/' # Match
5
'/this-is-not-an-article/' # Not a match!
Copied!
You'll notice that Django's
url helper takes a second parameter, which is the method to send the request to. In the homepage example, if the URL matches an empty string, the request is routed to theme.home . The definition for theme.home lives in ubyssey/views/main.py:1
def home(self, request):
2
frontpage = ArticleHelper.get_frontpage(
3
sections=('news', 'culture', 'opinion', 'sports', 'features', 'science'),
4
max_days=7
5
)
6
​
7
frontpage_ids = [int(a.id) for a in frontpage[:2]]
8
​
9
sections = ArticleHelper.get_frontpage_sections(exclude=frontpage_ids)
10
​
11
try:
12
articles = {
13
'primary': frontpage[0],
14
'secondary': frontpage[1],
15
'thumbs': frontpage[2:4],
16
'bullets': frontpage[4:6],
17
​
18
}
19
except IndexError:
20
raise Exception('Not enough articles to populate the frontpage!')
21
​
22
popular = ArticleHelper.get_popular()[:5]
23
​
24
blog = ArticleHelper.get_frontpage(section='blog', limit=5)
25
​
26
title = '%s - UBC\'s official student newspaper' % self.SITE_TITLE
27
​
28
context = {
29
'title': title,
30
'meta': {
31
'title': title,
32
'description': 'Weekly student newspaper of the University of British Columbia.',
33
'url': self.SITE_URL
34
},
35
'articles': articles,
36
'sections': sections,
37
'popular': popular,
38
'blog': blog,
39
'day_of_week': datetime.now().weekday(),
40
}
41
​
42
return render(request, 'homepage/base.html', context)
Copied!
The above code might look a little daunting if you're new to Python, but don't worry -- we'll be focusing mainly on the last several lines, specifically the definition for
context and the final return statement.You're almost ready to start coding!
Before we go any further, you should take a minute to set up a code editor if you haven't already. We recommend using something like Atom or VS Code, but you can use vim or emacs if you're into that. Once you have an editor installed, load the
ubyssey.ca folder so that all the files are in one place.Hint: In Atom, you can click
File > Add Project Folder and select the ubyssey.ca folder.2. Loading and preparing data
The
home method is responsible for sending an HTML response back to the user, but before it can do that, it has to fetch and prepare all the data it needs. Most of the calls to ArticleHelper fetch data from our database, which is then added to the context structure at the end of the method.To keep things simple for this tutorial, we won't be fetching data from the database, but we will be adding data to the
context structure.The
context data structure is a primitive type called a dictionary, which is just Python's version of a hash table. It simply creates a map of keys to values:1
my_dict = {
2
'name': 'John',
3
'age': 22,
4
}
5
​
6
print 'My name is ' + my_dict['name']
7
# > My name is John
8
​
9
print 'My age is ' + str(my_dict['age'])
10
# > My age is 22
Copied!
The data that we need to generate, in this case, is a random number between 1 and 10. Here's how you'd do that in Python:
1
import random
2
​
3
rand_num = random.randint(1, 10)
Copied!
Now it's your turn!
Extend the
context data structure to include a random number from 1 to 10.3. Putting data into a template
The final line in the
home method makes a call to the render method, which (you guessed it!) renders the final output of the homepage. You'll notice that it takes three arguments:request- the Django request object, stores information about the incoming requesthomepage/base.html- the template file to usecontext- the context to pass to the template
In this case, the
render method loads the homepage/base.html template and returns the result of rendering that template with the given context.This simple example shows how a Django template reads data from the context:
1
context = {
2
'name': 'Sarah',
3
}
4
​
5
return render(request, 'my-template.html', context)
Copied!
In a Django template, all of the keys defined in the context dictionary become available as named variables. To print one of these variables, simple wrap its name in double curly braces:
1
<strong>Hi, my name is {{ name }}!</strong>
Copied!
This will produce:
Hi, my name is Sarah!
Your next step
Edit
templates/homepage/base.html so that it prints the following at the top of the page:I completed the getting started tutorial!
YOUR RANDOM NUMBER HERENow if you reload the homepage, you should see your text!
Last modified 3yr ago