https://github.com/app-generator/jinja-sb-admin
Jinja Template - SB Admin (Free Version) | AppSeed
https://github.com/app-generator/jinja-sb-admin
appseed jinja2-template open-source sb-admin
Last synced: 5 months ago
JSON representation
Jinja Template - SB Admin (Free Version) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/jinja-sb-admin
- Owner: app-generator
- License: other
- Created: 2020-08-25T14:33:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-01T11:25:05.000Z (about 4 years ago)
- Last Synced: 2025-03-11T05:55:53.429Z (about 1 year ago)
- Topics: appseed, jinja2-template, open-source, sb-admin
- Language: CSS
- Homepage: https://appseed.us/generator/sb-admin/
- Size: 8.87 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [SB Admin](https://appseed.us/generator/sb-admin/) Flask/Jinja
Open-source **Flask/Jinja Template** generated by `AppSeed` op top of **[SB Admin](https://appseed.us/generator/sb-admin/)**, an iconic dashboard design. 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).
- 👉 [SB Admin Flask](https://appseed.us/product/sb-admin/flask/) - product page
- 👉 [SB Admin Flask](https://flask-sb-admin.appseed-srv1.com/) - LIVE Deployment
> Built with [SB Admin Generator](https://appseed.us/generator/sb-admin/)
- Timestamp: `2022-06-01 14:19`
- Build ID: `0e265eca-1039-41c5-aaf0-e68cb6b4763b`
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
> Features
- `Up-to-date dependencies`
- Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
## ✨ Start the app in Docker
> **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ # Get the code
$ git clone https://github.com/app-generator/jinja-sb-admin.git
$ cd jinja-sb-admin
```
> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance.
```txt
DEBUG=True
```
> **Step 3** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✨ How to use it
> Download the code
```bash
$ # Get the code
$ git clone https://github.com/app-generator/jinja-sb-admin.git
$ cd jinja-sb-admin
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ # CMD
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
## ✨ Code-base structure
The project has a simple, intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/__init__.py
|-- apps/
| |-- 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
| 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
|
|-- ************************************************************************
```
## ✨ PRO Version
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
Soft UI Dashboard is a premium Bootstrap 5 Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Soft UI Dashboard PRO is ready to help you create stunning websites and web apps.
- 👉 [Soft UI Dashboard PRO Flask](https://appseed.us/product/soft-ui-dashboard-pro/flask/) - Product Page
- 👉 [Soft UI Dashboard PRO Flask](https://flask-soft-ui-dashboard-pro.appseed-srv1.com/) - LIVE Demo
---
[SB Admin](https://appseed.us/generator/sb-admin/) Flask/Jinja - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.