Jinja Template - Paper Dashboard
Tags: webdev, jinja, appseed
Published: 2020-08-11 19:47:30

---
title: Jinja Template - Paper Dashboard
published: true
description: Paper Dashboard design (free version) is now available as Jinja2 template under the MIT license
tags: webdev, jinja, appseed
cover_image: https://raw.githubusercontent.com/app-generator/jinja-template-paper-dashboard/master/media/jinja-template-paper-dashboard-screen.png
---
This article presents a free **Jinja2 template** generated by the [AppSeed](https://appseed.us/?ref=dev) platform using **Paper Dashboard** design, crafted by Creative-Tim, as input. 
The project is basically a lightweight Flask app (no database or hard dependencies) that can be used for production-ready Python projects like Django/Flask dashboards. 
Thanks for reading!

---

> Jinja Template - Links

- [Jinja Template - Paper Dashboard](https://github.com/app-generator/jinja-template-paper-dashboard), the source code
- [Jinja Paper Dashboard Demo](https://jinja-template-paper-dashboard.appseed.us/) - LIVE deploy

---

![Jinja Template - Paper Dashboard, animated presentation.](https://raw.githubusercontent.com/app-generator/jinja-template-paper-dashboard/master/media/jinja-template-paper-dashboard-intro.gif) 

---

## What is [Jinja2](https://jinja.palletsprojects.com/en/2.11.x/)

Jinja2 is a Python template engine used to generate HTML or XML returned to the user via an HTTP response. 

For those who have not been exposed to a templating language before, such languages essentially contain variables as well as some programming logic, which when evaluated (or rendered into HTML) are replaced with actual values.

---

## Why do we need Jinja?

**Sandboxed Execution** - It provides a protected framework for automation of testing programs, whose behavior is unknown and must be investigated.

**HTML Escaping** Jinja 2 has a powerful automatic HTML Escaping, which helps to prevent Cross-site Scripting (XSS Attack). There are special characters like >,<,&, etc. which carry special meanings in the templates. So, if you want to use them as regular text in your documents then, replace them with entities. Not doing so might lead to XSS-Attack.

**Template Inheritance** - This feature helps us to generate new pages starting from a base template that we *inherit* a common structure. 

--- 

> How to get Jinja2

To start playing with it, just open a terminal and type:

```bash
$ pip install jinja2
```

---

## Jinja in action

> Simple runtime replace 

```python
>>> from jinja2 import Template
>>> t = Template("Hello {{ token }}!")
>>> t.render(token="Jinja2")
u'Hello Jinja2!'
```

The engine will replace the inner `token` with value `Jinja2`. This is quite useful when we use this block for different `token` values.

> Jinja Links

- [Jinja2](https://palletsprojects.com/p/jinja/) - the official website
- [Jinja2 Documentation](https://jinja.palletsprojects.com/)

--- 

### Jinja Paper Dashboard

To use or compile the project we need at least Python3 properly installed in our workstation. If you're not sure about it, please open a terminal window and type `python --version`. 

```bash
$ # Check Python version
$ python --version
Python 3.7.2 # <--- All good
```
Using GIT to clone the source code is also recommended but optional. We can download the sources in ZIP format, no need to be familiar with a versioning system like GIT, in our case.

---

> Codebase structure

```bash
< PROJECT ROOT >
   |
   |-- app/__init__.py
   |-- app/
   |    |-- static/
   |    |    |-- <css, JS, images>         # UI KIT assets
   |    |
   |    |-- templates/
   |    |    |
   |    |    |-- includes/                 # HTML chunks
   |    |    |    |
   |    |    |    |-- navigation.html      # Top bar
   |    |    |    |-- sidebar.html         # Left sidebar
   |    |    |    |-- scripts.html         # JS scripts
   |    |    |    |-- footer.html          # The common footer
   |    |    |
   |    |    |-- layouts/                  # App Layouts
   |    |    |    |
   |    |    |    |-- base.html            # Used by common pages 
   |    |    |    |-- base-fullscreen.html # Used by auth pages 
   |    |    |
   |    |  index.html                      # The default page
   |    |  login.html                      # Auth Login Page
   |    |  register.html                   # Registration Page
   |    |  page-404.html                   # Error 404 page 
   |    |  page-500.html                   # Error 500 page
   |    |    *.html                        # All other pages 
   |
   |-- requirements.txt
   |
   |-- run.py
   |
   |-- ********************************************
```

---

> How to compile the source

The following (simplified) snippet is extracted from the [README](https://github.com/app-generator/jinja-template-paper-dashboard/blob/master/README.md) file. For full set up (major OSs) please access the project sources and follow the build instructions related to your OS. In case of any issues, don't hesitate to ask anything in the comments or request for LIVE support via [Discord](https://discord.gg/fZC6hup).

```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/jinja-template-paper-dashboard.git
$ cd jinja-template-paper-dashboard
$
$ # Virtualenv set up
$ virtualenv env
$ source env/bin/activate
$
$ # Install requirements
$ pip3 install -r requirements.txt
$
$ # Set the FLASK_APP environment variable
$ export FLASK_APP=run.py
$
$ # Run the Jinja Template
$ flask run
$
$ # Access the UI in browser: http://127.0.0.1:5000/
```

If all goes well, we should see in the browser some nice pages, rendered by Jinja:

- [UI Icons](https://jinja-template-paper-dashboard.appseed.us/icons.html)
- [Google Maps](https://jinja-template-paper-dashboard.appseed.us/map.html)
- [UI Alerts](https://jinja-template-paper-dashboard.appseed.us/notifications.html)
- [Login Page](https://jinja-template-paper-dashboard.appseed.us/login.html)
- [User Profile](https://jinja-template-paper-dashboard.appseed.us/user.html)

---

![Jinja Template - Paper Dashboard, user profile.](https://raw.githubusercontent.com/app-generator/jinja-template-paper-dashboard/master/media/jinja-template-paper-dashboard-screen-user.png)

---

> UI Alerts & Notification

![Jinja Template - Paper Dashboard, UI Alerts.](https://raw.githubusercontent.com/app-generator/jinja-template-paper-dashboard/master/media/jinja-template-paper-dashboard-screen-alerts.png)

---

> Google Maps 

![Jinja Template - Paper Dashboard, Google Maps.](https://raw.githubusercontent.com/app-generator/jinja-template-paper-dashboard/master/media/jinja-template-paper-dashboard-screen-maps.png)

---

>  Thank you!

---

### Links & resources

- [Jinja Template Paper Sources](https://github.com/app-generator/jinja-template-paper-dashboard), published on Github
- Access the [AppSeed](https://appseed.us/ref=dev) platform for more OSS projects
- Get support via [Discord](https://discord.gg/fZC6hup) - 24/7 LIVE service