app-generator / flask-datta-able Goto Github PK

Datta Able - Open-Source Flask Dashboard | AppSeed

Home Page: https://appseed.us/product/datta-able/flask/

License: Other

Dockerfile 0.07% Python 2.81% HTML 40.11% CSS 54.10% JavaScript 2.29% SCSS 0.59% Shell 0.02%

datta-able flask-app flask-dashboard flask-template flask-sample-application flask-admin-template flask-bootstrap flask-bootstrap4 flask-bs4

flask-datta-able's Introduction

Datta Able Flask

Open-source Flask Dashboard generated by AppSeed on top of a modern design. Datta Able Bootstrap Lite is the most stylized Bootstrap 4 Lite Admin Template, around all other Lite/Free admin templates in the market. It comes with highly feature-rich pages and components with fully developer-centric code.

👉 Datta Able Flask - Product page
👉 Datta Able Flask - LIVE demo

Features

Have questions? Contact Support (Email & Discord) provided by AppSeed

Free Version	PRO Version	Custom Development
✓ Up-to-date dependencies	Everything in Free, plus:	Everything in PRO, plus:
✓ Best Practices	✅ Premium Bootstrap 5 Design	✅ 1mo Custom Development
✓ DB: SQLite, MySql	✅ `OAuth` for Github	✅ Team: PM, Developer, Tester
✓ DB Tools: ORM, Flask-Migrate	✅ `Extended User Model`	✅ Weekly Sprints
✓ Session-Based authentication	✅ `Users Roles`	✅ Technical SPECS
✓ `Docker`	✅ `Private REPO Access`	✅ Documentation
✓ `CI/CD` Flow via Render	✅ PRO Support - Email & Discord	✅ 30 days Delivery Warranty
✓ `Free Support`	✅ Deployment Assistance	-
---------------------------------	---------------------------------	---------------------------------
✓ LIVE Demo	🚀 LIVE Demo `PRO`	🛒 `Order`: $4,999 (GUMROAD)

✅ Start in `Docker`

👉 Step 1 - Download the code

$ git clone https://github.com/app-generator/flask-datta-able.git
$ cd flask-datta-able

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build

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

✅ Create `.env` file

The meaning of each variable can be found below:

DEBUG: if True the app runs in develoment mode
- For production value False should be used
ASSETS_ROOT: used in assets management
- default value: /static/assets
OAuth via Github
- GITHUB_ID=<GITHUB_ID_HERE>
- GITHUB_SECRET=<GITHUB_SECRET_HERE>

✅ Manual Build

Download the code

$ git clone https://github.com/app-generator/flask-datta-able.git
$ cd flask-datta-able

👉 Set Up for `Unix`, `MacOS`

Install modules via VENV

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

Set Up Flask Environment

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

Start the app

$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server

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
$ pip 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
// OR
$ flask run --cert=adhoc # For HTTPS server

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:

< 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
   |
   |-- ************************************************************************

✅ PRO Version

For more components, pages and priority on support, feel free to take a look at this amazing starter:

Designed for those who like bold elements and beautiful websites, Datta Able is the most stylish Bootstrap 5 Admin Template compare to all other Bootstrap admin templates. It comes with high feature-rich pages and components with fully developer-centric code.

Enhanced UI - more pages and components
Improved Authentication, Password Strength Checker
Automatic User Suspension on multiple failed logins
Extended User profile
Users Management (restricted to admins)

Datta Able Flask - Open-source starter generated by App Generator.

flask-datta-able's People

Contributors

Stargazers

Watchers

Forkers

pbehnke neiodavince deve0ps edurguti cmosley hsweif netflow0 cristianpachacama echavarria wolf-de bkeb deduble nayoung-jin hongfeichencu oumadennisomondi stereovibe jsmnkk redolat dreinthebay masbrodin sorcecoder dt021 2cool2envy litingzhou1 qmxp55 apecnascimento aliorabi mindaugasvaitkus2 siberianbear aasim-syed ngotrungkien kamelfluff lsokal 0therguys mellasmpa mridho017 xuanhoang1302 linxing filippoaleotti duyuxuan sky965 manojfyi eastsunwong arielmesquitaa felisd opere44 xz328 zhujj09 qaingenieros natkirpa saurabhh333 zinohome ch0bus myplayareas vuonglb sxx2022 fauzi41 bala-anjane jyotijha12 vladislav-boyko-tstechpro jisungs eljeffeg he2car nathanl85 oualidinx n1cecooper whoulden retry-later hazho hazhohuman ysravankumar vickyyyy6666 neonglb luissequeira94 admin-dashboards razkk swagricardo arynas jsorsby94 grantrosse alejomejia1 cortajarena rytec seasun2016 asahijoe kt-dev1 jeancff akashtalole joseamarcucci enravi zincoin aitobox amodn08 one-dev-space otselen01 leeworker diogofontes-git uzieee jasmitavirani roadlogger

flask-datta-able's Issues

Possible to host flask-datta-able website at different APPLICATION_ROOT

Hi, I'm experimenting with using your great flask-datta-able project as wsgi server behind an nginx reverse proxy that hosts multiple sites. I'm trying to figure out how to configure this and I'm wondering if it is currently possible? Normally with a flask app, I think you would include (in apps/init.py):

app.config['APPLICATION_ROOT'] = '/somesubfolder'

but it appears that there are a number of hardcoded urls throughout flask-datta-able that would prevent this from working, for example in: apps/templates/includes/scripts.html

Is it possible to configure flask-datta-able to run at some subdirectory of a website?

Thanks for any guidance.

Not an issue, possible customization of flask-security-too templates

Is it possible to customize the flask-security-too templates also accordingly your flask-datta-able? Can I receive a quote of it?

ImportError: cannot import name 'safe_str_cmp' from 'werkzeug.security'

The project no longer runs correctly per the instructions. You are met with the error "ImportError: cannot import name 'safe_str_cmp' from 'werkzeug.security'"

This functionality was recently deprecated and removed, see here: pallets/werkzeug#2359

This is impacting flask-login, which it seems is not updated yet: https://github.com/maxcountryman/flask-login/blob/0f94639858946ea8e921743db684b6da97d46385/CHANGES.md

I need some instructions on how to remove the navbar on left side the sidebar

I need some instructions on how to remove the navbar on left side the sidebar and update the style.css to use all space avaiable when sidebar is removed.

sqlalchemy dependency failing

Hi I wasnt able to get the app to run unfortunately.
It has to do something with sqlalchemy dependencys. Here my error log

PS C:\Users\PavelH\Documents\GitHub\hegler-tech-dashboard> flask run
 * Tip: There are .env or .flaskenv files present. Do "pip install python-dotenv" to use them.
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask_sqlalchemy\__init__.py:851: UserWarning: Neither SQLALCHEMY_DATABASE_URI nor SQLALCHEMY_BINDS is set. Defaulting SQLALCHEMY_DATABASE_URI to "sqlite:///:memory:".
  warnings.warn(
c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask_sqlalchemy\__init__.py:872: FSADeprecationWarning: SQLALCHEMY_TRACK_MODIFICATIONS adds significant overhead and will be disabled by default in the future.  Set it to True or False to suppress this warning.
  warnings.warn(FSADeprecationWarning(
Traceback (most recent call last):
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "C:\Users\PavelH\AppData\Local\Programs\Python\Python39\Scripts\flask.exe\__main__.py", line 7, in <module>
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 967, in main
    cli.main(args=sys.argv[1:], prog_name="python -m flask" if as_module else None)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 586, in main
    return super(FlaskGroup, self).main(*args, **kwargs)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\core.py", line 782, in main
    rv = self.invoke(ctx)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\decorators.py", line 73, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\click\core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 848, in run_command
    app = DispatchingApp(info.load_app, use_eager_loading=eager_loading)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 305, in __init__
    self._load_unlocked()
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 330, in _load_unlocked
    self._app = rv = self.loader()
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 392, in load_app
    app = locate_app(self, import_name, None, raise_if_not_found=False)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 257, in locate_app
    return find_best_app(script_info, module)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 83, in find_best_app
    app = call_factory(script_info, app_factory)
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\flask\cli.py", line 117, in call_factory
    return app_factory(script_info)
  File "C:\Users\PavelH\Documents\GitHub\hegler-tech-dashboard\app\__init__.py", line 39, in create_app
    register_blueprints(app)
  File "C:\Users\PavelH\Documents\GitHub\hegler-tech-dashboard\app\__init__.py", line 22, in register_blueprints
    module = import_module('app.{}.routes'.format(module_name))
  File "c:\users\pavelh\appdata\local\programs\python\python39\lib\importlib\__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1030, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1007, in _find_and_load
  File "<frozen importlib._bootstrap>", line 986, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 680, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 790, in exec_module
  File "<frozen importlib._bootstrap>", line 228, in _call_with_frames_removed
  File "C:\Users\PavelH\Documents\GitHub\hegler-tech-dashboard\app\base\routes.py", line 17, in <module>
    from app.base.models import User
  File "C:\Users\PavelH\Documents\GitHub\hegler-tech-dashboard\app\base\models.py", line 7, in <module>
    from sqlalchemy import Binary, Column, Integer, String
ImportError: cannot import name 'Binary' from 'sqlalchemy' (c:\users\pavelh\appdata\local\programs\python\python39\lib\site-packages\sqlalchemy\__init__.py)