Skip to content

app-generator/flask-now-ui-dashboard

Repository files navigation

Open-source Flask Dashboard 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.


🚀 Built with App 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

Flask Now UI Dashboard - Starter generated by AppSeed.


✨ Start the app in Docker

👉 Step 1 - Download the code from the GH repository (using GIT)

$ git clone https://github.com/app-generator/flask-now-ui-dashboard.git $ cd flask-now-ui-dashboard

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build 

Visit http://localhost:5085 in your browser. The app should be up & running.


✨ How to use it

Download the code

$ 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

$ virtualenv env $ source env/bin/activate $ pip3 install -r requirements.txt

Set Up Flask Environment

$ export FLASK_APP=run.py $ export FLASK_ENV=development

Start the app

$ 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

$ # CMD  $ set FLASK_APP=run.py $ set FLASK_ENV=development $ $ # Powershell $ $env:FLASK_APP = ".\run.py" $ $env:FLASK_ENV = "development"

Start the app

$ 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:

< 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, JS, images> # 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 - Open-source starter generated by App Generator.