The advent of modern JavaScript libraries such as React.js and Vue.js has changed frontend web development for the better. These libraries ship with features including SPA (Single Page Applications), which is the dynamic loading of the content in web pages without a full reload to the browser.
The concept behind most Single Page Applications is client-side rendering. In client-side rendering, the majority of content is rendered in a browser using JavaScript; on page load, the content doesn’t load initially until the JavaScript has been fully downloaded and renders the rest of the site.
Client-side rendering is a relatively recent concept and there are trade-offs associated with its use. A notable negative side is that, since the content is not exactly rendered until the page is updated using JavaScript, SEO (Search Engine Optimization) for the website will suffer as there will hardly be any data for search engines to crawl.
Server-side rendering, on the other hand, is the conventional way of getting HTML pages rendered on a browser. In the older server-side rendered applications, the web application is built using a server-side language such as PHP. When a web page is requested by a browser, the remote server adds the (dynamic) content and delivers a populated HTML page.
Just as there are downsides to client-side rendering, server-side rendering makes the browser send server requests too frequently and performs repetitions of full-page reloads for similar data. There are JavaScript frameworks that can initially load the web page with an SSR (Server-Side Rendering) solution, then use a framework to handle the further dynamic routing and fetch only necessary data. The resulting applications are called Universal Applications.
In summary, a universal application is used to describe JavaScript code that can execute on the client and the server-side. In this article, we will build a Universal Recipe application using Nuxt.js.
Nuxt.js is a higher-level framework for developing Universal Vue.js applications. Its creation was inspired by React’s Next.js and it helps to abstract the difficulties (server configuration and client code distribution) that arise in setting up server-side rendered Vue.js applications. Nuxt.js also ships with features that aid development between client-side and server-side such as async data, middleware, layouts, and so on.
Note: We can refer to the application we build as Server-Side rendered (SSR) because Vue.js already implements Client-Side rendering by default when we create a Single Page Application. The application is, in fact, a Universal application.
In this article, we will see how to create a Universal application using Django and Nuxt.js. Django will handle the backend operations and provide the APIs using the DRF (Django Rest Framework), while Nuxt.js will create the frontend.
Here’s a demo of the final application:
We see that the final application is a recipes application that performs CRUD operations.
To follow along with this tutorial, you will need the following installed on your machine:
The tutorial assumes that the reader has the following:
This tutorial was verified with Python v3.7.7, Django v3.0.7, Node v14.4.0, npm
v6.14.5, and nuxt
v2.13.0.
In this section, we will set up the backend and create all the directories that we need to get things up and running, so launch a new instance of a terminal and create the project’s directory by running this command:
Next, we will navigate into the directory:
Now, we will install Pipenv using Pip:
And activate a new virtual environment:
Note: You should skip the first command if you already have Pipenv installed on your computer.
Let’s install Django and other dependencies using Pipenv:
Note: After activating a new virtual environment using Pipenv, each command line in the terminal will be prefixed with the name of the present working directory. In this case, it is (recipes_app)
.
Now, we will create a new Django project called api
:
Navigate to the project directory:
Create a Django application called core
:
Let’s register the core
application, together with rest_framework
and cors-headers
, so that the Django project recognizes it. Open the api/settings.py
file and update it accordingly:
We added http://localhost:3000
to the whitelist because the client application will be served on that port and we want to prevent CORS (Cross-Origin Resource Sharing) errors. We also added MEDIA_URL
and MEDIA_ROOT
because we will need them when serving images in the application.
Let’s create a model to define how the Recipe items should be stored in the database, open the core/models.py
file and completely replace it with the snippet below:
The code snippet above describes six properties on the Recipe model:
name
ingredients
picture
difficulty
prep_time
prep_guide
We need serializers to convert model instances to JSON so that the frontend can work with the received data. We will create a core/serializers.py
file and update it with the following:
In the code snippet above, we specified the model to work with and the fields we want to be converted to JSON.
Django provides us with an admin interface out of the box; the interface will make it easy to test CRUD operations on the Recipe model we just created, but first, we will do a little configuration.
Open the core/admin.py
file and completely replace it with the snippet below:
Let’s create a RecipeViewSet
class in the core/views.py
file, completely replace it with the snippet below:
The viewsets.ModelViewSet
provides methods to handle CRUD operations by default. We just need to do specify the serializer class and the queryset
.
Head over to the api/urls.py
file and completely replace it with the code below. This code specifies the URL path for the API:
Now, create a urls.py
file in the core
directory and paste in the snippet below:
In the code above, the router
class generates the following URL patterns:
/recipes/
- CREATE and READ operations can be performed on this route./recipes/{id}
- READ, UPDATE, and DELETE operations can be performed on this route.Because we recently created a Recipe model and defined its structure, we need to make a Migration file and apply the changes on the model to the database, so let’s run the following commands:
Now, we will create a superuser account to access the admin interface:
You will be prompted to enter a username, email, and password for the superuser. Be sure to enter details that you can remember because you will need them to log in to the admin dashboard shortly.
That’s all the configuration that needs to be done on the backend. We can now test the APIs we created, so let’s start the Django server:
Once the server is running, head over to localhost:8000/api/recipes/
to ensure it works:
We can create a new Recipe item using the interface:
We can also perform DELETE, PUT, and PATCH operations on specific Recipe items using their id
primary keys. To do this, we will visit an address with this structure /api/recipe/{id}
. Let’s try with this address — localhost:8000/api/recipes/1
:
That’s all for the backend of the application, now we can move on to fleshing out the frontend.
In this section of the tutorial, we will build the frontend of the application. We want to place the directory for the frontend code in the root of the recipes_app
directory. So, navigate out of the api
directory (or spin up a fresh terminal to run alongside the previous one) before running the commands in this section.
Let’s create a nuxt
application called client
with this command:
Note: Preceding create-nuxt-app
with npx
installs the package if it is not already installed globally on your machine.
Once the installation is complete, create-nuxt-app
will ask a few questions about extra tools to be added. For this tutorial, the following choices were made:
? Project name: client
? Programming language: JavaScript
? Package manager: Npm
? UI framework: Bootstrap Vue
? Nuxt.js modules: Axios
? Linting tools:
? Testing framework: None
? Rendering mode: Universal (SSR / SSG)
? Deployment target: Server (Node.js hosting)
? Development tools:
This will trigger the installation of dependencies using the selected package manager.
Navigate to the client
directory:
Let’s run the following commands to start the application in development mode:
npm run dev
Once the development server has started, head over to localhost:3000
to see the application:
Now, let’s take a look at the directory structure of the client
directory:
├── client
├── assets/
├── components/
├── layouts/
├── middleware/
├── node_modules/
├── pages/
├── plugins/
├── static/
└── store/
Here’s a breakdown of what these directories are for:
.vue
files in this directory and uses the information to create the application’s router./
.There is also a nuxt.config.js
file in the client
directory, this file contains custom configuration for the Nuxt.js app.
Before we continue, download this zip file of image assets, extract it, and put the images
directory inside the static
directory.
In this section, we will add some .vue
files to the pages
directory so that our application will have five pages:
Let’s add the following .vue
files and folders to the pages
directory so we have this exact structure:
├── pages/
├── recipes/
├── _id/
└── edit.vue
└── index.vue
└── add.vue
└── index.vue
└── index.vue
The file structure above will generate the following routes:
/
→ handled by pages/index.vue
/recipes/add
→ handled by pages/recipes/add.vue
/recipes/
→ handled by pages/recipes/index.vue
/recipes/{id}/
→ handled by pages/recipes/_id/index.vue
/recipes/{id}/edit
→ handled by pages/recipes/_id/edit.vue
A .vue
file or directory prefixed by an underscore will create a dynamic route. This is useful in our application as it will make it easy to display different recipes based on their IDs (e.g., recipes/1/
, recipes/2/
, and so on).
In Nuxt.js, Layouts are a great help when you want to change the look and feel of your application. Now, each instance of a Nuxt.js application ships with a default Layout, we want to remove all the styles so they do not interfere with our application.
Open the layouts/default.vue
file and replace it with the following snippet below:
Let’s update the pages/index.vue
file with the code below:
From the code above, <nuxt-link>
is a Nuxt.js component that can be used to navigate between pages. It is very similar to the <router-link>
component from Vue Router.
Let’s start the frontend development server (if it isn’t already running):
Then visit localhost:3000
and observe the Homepage:
Always ensure that the Django backend server is always running in another instance of the terminal because the frontend will begin communicating with it for data shortly.
Every page in this application will be a Vue
Component and Nuxt.js provides special attributes and functions to make the development of applications seamless. You can find all these special attributes in the official documentation.
For the sake of this tutorial, we will make use of two of these functions:
head()
- This method is used to set specific <meta>
tags for the current page.asyncData()
- This method is used to fetch data before the page component is loaded. The object returned is then merged with the page component’s data. We will make use of this later in this tutorial.Let’s create a Vue.js component called RecipeCard.vue
in the components
directory and update it with the snippet below:
The component above accepts two props:
recipe
object which contains information about a particular recipe.onDelete
method will be triggered whenever a user clicks on the button to delete a recipe.Next, open the pages/recipes/index.vue
and update it with the snippet below:
Let’s start the frontend development server (if it isn’t already running):
Then, visit localhost:3000/recipes
, and observe the recipes listing page:
From the image above, we see that three recipe cards appear even though we set recipes
to an empty array in the component’s data section. The explanation for this is that the method asyncData
is executed before the page loads and it returns an object that updates the component’s data.
Now, all we need to do is modify the asyncData
method to make an api
request to the Django backend and update the component’s data with the result.
Before we do that, we have to configure Axios
. Open the nuxt.config.js
file and update it accordingly:
Note: This assumes you selected Axios
when using create-nuxt-app
. If you did not, you will need to manually install and configure the modules
array.
Now, open the pages/recipes/index.vue
file and replace the <script>
section with the one below:
In the code above, asyncData()
receives an object called context
, which we destructure to get $axios
. You can check out all the attributes of context
in the official documentation.
We wrap asyncData()
in a try...catch
block because we want to prevent the bug which will occur if the backend server isn’t running and Axios fails to retrieve data. Whenever that happens, recipes
is just set to an empty array instead.
This line of code:
Is a shorter version of:
The deleteRecipe()
method deletes a particular recipe, fetches the most recent list of recipes from the Django backend, and finally updates the component’s data.
We can start the frontend development server (if it isn’t already running) now and we will see that the recipe cards are now being populated with data from the Django backend.
For this to work, the Django backend server has to be running and there must be some data (entered from the admin interface) available for the Recipe items.
Let’s visit localhost:3000/recipes
:
You can also try deleting recipe items and watch them update accordingly.
As we already discussed, we want to be able to add new recipes from the frontend of the application so open the pages/recipes/add/
file and update it with the following snippet:
In submitRecipe()
, once the form data has been posted and the recipe is created successfully, the app is redirected to /recipes/
using this.$router
.
Let’s create the view that allows a user to view a single Recipe item, open the /pages/recipes/_id/index.vue
file and paste in the snippet below:
We introduce the params
key seen in the asyncData()
method. In this case, we are using params
to get the ID
of the recipe we want to view. We extract params
from the URL
and pre-fetch its data before displaying it on the page.
We can observe a single Recipe item on the web browser.
We need to create the view that allows the user to edit and update a single Recipe item, so open the /pages/recipes/_id/edit.vue
file and paste in the snippet below:
In the code above, the submitRecipe()
method has a conditional statement whose purpose is to remove the picture of an edited Recipe item from the data to be submitted if the picture was not changed.
Once the Recipe item has been updated, the application is redirected to the Recipes list page — /recipes/
.
The application is fully functional, however, we can give it a smoother look by adding transitions, which allow us to smoothly change CSS property values (from one value to another), over a given duration.
We will set up transitions in the nuxt.config.js
file. By default, the transition name is set to page
, which means that the transitions we define will be active on all pages.
Let’s include the styling for the transition. Create a directory called css
in the assets
directory and add a transitions.css
file within. Now open the transitions.css
file and paste in the snippet below:
Open the nuxt.config.js
file and update it accordingly to load the CSS file we just created:
Save your changes and open the application in your browser:
Now, our application will change frames on each navigation in a sleek way.
In this article, we started out by learning the differences between client-side and server-side rendered applications. We went on to learn what a universal application is and finally, we saw how to build a universal application using Nuxt.js and Django.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
Thanks for the article, but the main point is not described. How to make Django and Nuxt work together in a single environment? You writing axios requests like Nuxt and Django working on the same server, but this is not true. Django backend working on port 8000, Nuxt on 3000 and $axios.$get(‘/recipes/’) doesn’t works. As well as other requests to the backend.
I think the answer in nuxt configuration file:
This is as base url. All other urls will costruct from this point. And this is not single environment. You will have two separate servers running. Frontend (Nuxt) and Backend (Django)
A minute to say this is a great tutorial i learned a lot just from understanding the code and the steps. thanks a lot just one thing to report is the following: When trying to EDIT a recipe if we try to change the image an error gonna occur is that editedRecipe.IMAGE.INCLUDES IS NOT A FUNCTION the solution taht i found is this : if(typeof editedRecipe.image === ‘string’ && editedRecipe.image.includes(“http://”)){ delete editedActor[“image”] }
IT HAS to check if the image is a string data to do the includes of indexOf function or we fgonna have the error. thanks for the awsome work continue :)
I am getting the following error even after setting up the CORS in django as per the notes above:
Access to XMLHttpRequest at ‘http://127.0.0.1:8000/api/leagues’ from origin ‘http://192.168.0.11:3000’ has been blocked by CORS policy: No ‘Access-Control-Allow-Origin’ header is present on the requested resource.
Any help would be appreciated.
Great article. Written with so much clarity.
not working tutorial. after try migration we have error: MEDIA_ROOT = os.path.join(BASE_DIR, ‘media’) NameError: name ‘os’ is not defined
First of all you should import OS module.