Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/flask-now-ui-dashboard
Flask Dashboard - Now UI Design | AppSeed
https://github.com/app-generator/flask-now-ui-dashboard
flask-apps flask-dashboard flask-template jinja
Last synced: about 1 month ago
JSON representation
Flask Dashboard - Now UI Design | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-now-ui-dashboard
- Owner: app-generator
- License: other
- Created: 2019-06-03T13:40:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T15:02:26.000Z (12 months ago)
- Last Synced: 2024-06-11T12:47:21.595Z (3 months ago)
- Topics: flask-apps, flask-dashboard, flask-template, jinja
- Language: SCSS
- Homepage: https://appseed.us/admin-dashboards/flask-now-ui-dashboard
- Size: 5.64 MB
- Stars: 46
- Watchers: 4
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - app-generator/flask-now-ui-dashboard - Flask Dashboard - Now UI Design | AppSeed (SCSS)
README
# [Flask Now UI Dashboard](https://appseed.us/product/now-ui-dashboard/flask/)
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of a modern design. **Now UI Dashboard** is a responsive Bootstrap 4 kit provided for free by Invision and Creative Tim. Now UI Dashboard comes packed with all the 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.
- 👉 [Flask Now UI Dashboard](https://appseed.us/product/now-ui-dashboard/flask/) - Product page
- 👉 [Flask Now UI Dashboard](https://flask-now-ui-dashboard.appseed-srv1.com) - LIVE App deployment
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-06-09 11:53`
- ✅ `Up-to-date dependencies`
- ✅ Database: `sqlite`
- ✅ `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
- ✅ Session-Based authentication (via **flask_login**), Forms validation
- ✅ `Docker`
## ✨ Start the app in `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-now-ui-dashboard.git
$ cd flask-now-ui-dashboard
```
> 👉 **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.
## ✨ How to use it
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-now-ui-dashboard.git
$ cd flask-now-ui-dashboard
```
### 👉 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/`.
### 👉 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`
## ✨ Code-base structure
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
|
|-- ************************************************************************
```
---
[Flask Now UI Dashboard](https://appseed.us/product/now-ui-dashboard/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.