https://github.com/app-generator/flask-adminator
Flask Dashboard - Adminator Design | AppSeed
https://github.com/app-generator/flask-adminator
adminator adminator-app adminator-charts adminator-dashboard adminator-flask adminator-flask-app adminator-starter adminator-template adminator-theme adminator-webapp flask-adminator flask-starter flask-template-adminator
Last synced: 27 days ago
JSON representation
Flask Dashboard - Adminator Design | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-adminator
- Owner: app-generator
- License: other
- Created: 2020-07-10T14:48:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-08T06:27:38.000Z (over 1 year ago)
- Last Synced: 2025-03-11T05:55:49.062Z (about 1 month ago)
- Topics: adminator, adminator-app, adminator-charts, adminator-dashboard, adminator-flask, adminator-flask-app, adminator-starter, adminator-template, adminator-theme, adminator-webapp, flask-adminator, flask-starter, flask-template-adminator
- Language: JavaScript
- Homepage: https://appseed.us/product/adminator/flask/
- Size: 15.6 MB
- Stars: 44
- Watchers: 2
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - app-generator/flask-adminator - Flask Dashboard - Adminator Design | AppSeed (JavaScript)
README
# [Adminator Flask](https://appseed.us/product/adminator/flask/)
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of an iconic design. For newcomers, **Adminator** is one of the best open-source admin dashboard & control panel themes. Built on top of Bootstrap, `Adminator` provides a range of responsive, reusable, and commonly used components.
- 👉 [Adminator Flask](https://appseed.us/product/adminator/flask/) - product page
- 👉 [Adminator Flask](https://flask-adminator.appseed-srv1.com/) - LIVE Deployment
- 👉 [Complete documentation](https://docs.appseed.us/products/flask-dashboards/adminator) - `Learn how to use and update the product`
## ✅ Features
- `Up-to-date dependencies`
- Database: `sqlite`
- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- Session-Based authentication (via **flask_login**), Forms validation
- `Docker`
- UI: [Adminator](https://github.com/app-generator/adminator) **v2.0.3**
- Gulp-generated version
## ✅ Start in `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-adminator.git
$ cd flask-adminator
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✅ Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-adminator.git
$ cd flask-adminator
```
### 👉 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_DEBUG=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_DEBUG=1
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_DEBUG = 1
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app via `flask run`
- Access the `registration` page and create a new user:
- `http://127.0.0.1:5000/register`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:5000/login`
## ✅ Codebase
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- routes.py # Define app routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- routes.py # Define authentication routes
| | |-- models.py # Defines models
| | |-- forms.py # Define auth forms (login and register)
| |
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| | |-- includes/ # HTML chunks and components
| | | |-- navigation.html # Top menu component
| | | |-- sidebar.html # Sidebar component
| | | |-- footer.html # App Footer
| | | |-- scripts.html # Scripts common to all pages
| | |
| | |-- layouts/ # Master pages
| | | |-- base-fullscreen.html # Used by Authentication pages
| | | |-- base.html # Used by common pages
| | |
| | |-- accounts/ # Authentication pages
| | | |-- login.html # Login page
| | | |-- register.html # Register page
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- 404-page.html # 404 page
| | |-- *.html # All other pages
| |
| config.py # Set up the app
| __init__.py # Initialize the app
|
|-- requirements.txt # App Dependencies
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
## ✅ [PRO Version](https://appseed.us/product/material-dashboard2-pro/flask/)
> For more components, pages, and priority on support, feel free to take a look at this amazing starter:
**Flask** starter styled with **[Material Dashboard PRO](https://appseed.us/product/material-dashboard2-pro/flask/)**, a premium `Bootstrap 5` KIT from `Creative-Tim`.
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
- 👉 [Flask Material 2 PRO](https://appseed.us/product/material-dashboard2-pro/flask/) - Product page
- 👉 [Flask Material 2 PRO](https://flask-material-dashboard2-pro.appseed-srv1.com) - LIVE Demo
---
[Adminator Flask](https://appseed.us/product/adminator/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.