https://github.com/app-generator/jinja-paper-dashboard
Jinja Template - Paper Dashboard | AppSeed
https://github.com/app-generator/jinja-paper-dashboard
appseed creative-tim jinja2-template paper-dashboard
Last synced: 3 months ago
JSON representation
Jinja Template - Paper Dashboard | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/jinja-paper-dashboard
- Owner: app-generator
- License: other
- Created: 2020-08-09T04:20:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T08:09:12.000Z (over 4 years ago)
- Last Synced: 2025-07-12T19:20:27.164Z (3 months ago)
- Topics: appseed, creative-tim, jinja2-template, paper-dashboard
- Language: CSS
- Homepage: https://jinja-template-paper-dashboard.appseed.us/
- Size: 12.8 MB
- Stars: 26
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Jinja Paper Dashboard](https://docs.appseed.us/products/jinja-templates/paper-dashboard)
**Jinja Template** project generated by AppSeed on top of a **Paper Dashboard** design (free version). The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency. The project can be used as a codebase for future project or to migrate the Jinja files and assets to a legacy Python-based project that uses Jinja as template engine (Flask, Bottle, Django).
> Features:
- UI Kit: **Paper Dashboard** (Free Version) by **Creative-Tim**
- Render Engine: Flask / **Jinja2**
- Deployment scripts: Docker, Gunicorn/Nginx, HEROKU
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
> Links
- [Jinja Paper Dashboard](https://jinja-paper-dashboard.appseed-srv1.com) - LIVE Demo
- [Jinja Paper Dashboard](https://docs.appseed.us/products/jinja-templates/paper-dashboard) - product documentation
## UI Kit - [Paper Dashboard](https://appseed.us/ui-kit/paper-design)
*Vendor Notes* - Paper Dashboard2 is a beautiful Bootstrap 4 admin dashboard with a large number of components, designed to look neat and organized. If you are looking for a tool to manage and visualize data about your business, this dashboard is the thing for you. It combines colors that are easy on the eye, spacious cards, beautiful typography, and graphics. Paper Dashboard 2 comes packed with all plugins that you might need inside a project and documentation on how to get started. It is light and easy to use, and also very powerful.
## Build from sources
```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/jinja-paper-dashboard.git
$ cd jinja-paper-dashboard
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install requirements
$ pip3 install -r requirements.txt
$
$ # Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"
$
$ # Set up the DEBUG environment
$ # (Unix/Mac) export FLASK_ENV=development
$ # (Windows) set FLASK_ENV=development
$ # (Powershell) $env:FLASK_ENV = "development"
$
$ # Run the Jinja Template
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000 - specify the app port (default 5000)
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the UI in browser: http://127.0.0.1:5000/
```
## Code-base structure
The project has a simple structure, represented as bellow:
```bash
< PROJECT ROOT >
|
|-- app/__init__.py
|-- app/
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/
| | |
| | |-- includes/ # Page chunks, components
| | | |
| | | |-- navigation.html # Top bar
| | | |-- sidebar.html # Left sidebar
| | | |-- scripts.html # JS scripts common to all pages
| | | |-- footer.html # The common footer
| | |
| | |-- layouts/ # App Layouts (the master pages)
| | | |
| | | |-- base.html # Used by common pages like index, UI
| | | |-- base-fullscreen.html # Used by auth pages (login, register)
| | |
| | index.html # The default page
| | login.html # Auth Login Page
| | register.html # Auth Registration Page
| | page-404.html # Error 404 page (page not found)
| | page-500.html # Error 500 page (server error)
| | *.html # All other pages provided by the UI Kit
|
|-- requirements.txt
|
|-- run.py
|
|-- ************************************************************************
```
## Deployment
The project comes with a basic configuration for [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
### [Docker](https://www.docker.com/) execution
---
The steps to start the template using Docker:
> Get the code
```bash
$ git clone https://github.com/app-generator/jinja-paper-dashboard.git
$ cd jinja-paper-dashboard
```
> Start the app in Docker
```bash
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
```
Visit `http://localhost:5005` in your browser. The app should be up & running.
### [Gunicorn](https://gunicorn.org/)
---
Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
> Install using pip
```bash
$ pip install gunicorn
```
> Start the app using gunicorn binary
```bash
$ gunicorn --bind 0.0.0.0:8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
---
Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
> Install using pip
```bash
$ pip install waitress
```
> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
```bash
$ waitress-serve --port=8001 run:app
Serving on http://localhost:8001
```
Visit `http://localhost:8001` in your browser. The app should be up & running.
## Credits & Links
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website
---
[Jinja Paper Dashboard](https://docs.appseed.us/products/jinja-templates/paper-dashboard) - Provided by **AppSeed** [Web App Generator](https://appseed.us/app-generator).