samkomo / nashipai

Other
0 stars 0 forks source link

AdminLTE Flask

Open-source Flask Dashboard generated by AppSeed on top of an iconic design. For newcomers, AdminLTE is one of the best open-source admin dashboard & control panel theme. Built on top of Bootstrap, AdminLTE provides a range of responsive, reusable, and commonly used components.


πŸš€ Built with App Generator, Timestamp: 2022-05-30 20:53


AdminLTE - Full-Stack 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-adminlte.git
$ cd flask-adminlte


πŸ‘‰ 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-adminlte.git
$ cd flask-adminlte


πŸ‘‰ 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:


✨ 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 serves HTML files
   |    |    |-- routes.py                  # Define app routes
   |    |
   |    |-- trading/                        # Handles trading routes and data retrieval
   |    |    |-- routes.py                  # Define trading routes
   |    |    |-- models.py                  # Define data models
   |    |
   |    |-- authentication/                 # Handles auth routes (login and register)
   |    |    |-- routes.py                  # Define authentication routes  
   |    |    |-- models.py                  # Define models  
   |    |    |-- forms.py                   # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>          # CSS files, JavaScript 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
   |    |    |
   |    |    |-- trading/                   # Trading pages
   |    |         |-- index.html            # Trading dashboard page
   |    |         |-- *.html                # All other trading-related 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:

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 - Starter generated by AppSeed.



AdminLTE Flask - Open-source starter generated by App Generator.