https://github.com/app-generator/jinja-pixel-old
Jinja Template - Pixel Lite UI Kit | AppSeed
https://github.com/app-generator/jinja-pixel-old
appseed jinja-template pixel-lite
Last synced: 7 months ago
JSON representation
Jinja Template - Pixel Lite UI Kit | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/jinja-pixel-old
- Owner: app-generator
- License: other
- Created: 2020-08-16T14:36:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-08T10:12:55.000Z (almost 4 years ago)
- Last Synced: 2025-03-11T05:55:53.430Z (7 months ago)
- Topics: appseed, jinja-template, pixel-lite
- Language: CSS
- Homepage: https://appseed.us/jinja-template/jinja-template-pixel-uikit
- Size: 15.8 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask/Jinja Pixel Lite](https://appseed.us/apps/flask-apps/flask-pixel-bootstrap-uikit)
**Jinja Template** project generated by AppSeed on top of a modern UI Kit: Pixel is a free, fully responsive, and modern Bootstrap 4 UI Kit that will help you build creative and professional websites. The codebase is a super simple Flask project WITHOUT database, ORM, or any other hard dependency.
> Features:
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
- [SCSS compilation](#recompile-css) via **Gulp**
- UI Kit: **Pixel Lite** (Free Version) by **Themesberg**
- Render Engine: **Jinja2**
- Framework: Flask (no database, no hard dependencies)
- Free support via **Github** and [Discord](https://discord.gg/fZC6hup).
> Links
- [Flask/Jinja Pixel Lite](https://appseed.us/apps/flask-apps/flask-pixel-bootstrap-uikit) - Product page
- [Flask/Jinja Pixel Lite](https://jinja-pixel-lite.appseed-srv1.com/) - LIVE Demo
## Quick Start in [Docker](https://www.docker.com/)
> Get the code
```bash
$ git clone https://github.com/app-generator/jinja-pixel.git
$ cd jinja-pixel
```
> Start the app in Docker
```bash
$ docker-compose up --build
```
Visit `http://localhost:85` in your browser. The app should be up & running.
## Build from sources
```bash
$ # Clone the sources
$ git clone https://github.com/app-generator/jinja-pixel.git
$ cd jinja-pixel
$
$ # 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
|
|-- ************************************************************************
```
## Recompile CSS
To recompile SCSS files, follow this setup:
**Step #1** - Install tools
- [NodeJS](https://nodejs.org/en/) 12.x or higher
- [Gulp](https://gulpjs.com/) - globally
- `npm install -g gulp-cli`
- [Yarn](https://yarnpkg.com/) (optional)
**Step #2** - Change the working directory to `assets` folder
```bash
$ cd app/static/assets
```
**Step #3** - Install modules (this will create a classic `node_modules` directory)
```bash
$ npm install
// OR
$ yarn
```
**Step #4** - Edit & Recompile SCSS files
```bash
$ gulp scss
```
The generated file is saved in `static/assets/css` directory.
## 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/).
### [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
---
[Flask/Jinja Pixel Lite](https://appseed.us/apps/flask-apps/flask-pixel-bootstrap-uikit) - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).