app-generator/flask-soft-ui-design-pro

Soft UI Design PRO - Flask Template | AppSeed

Soft UI Design PRO Flask

Flask Web App generated by AppSeed op top of a modern design. Designed for those who like bold elements and beautiful websites, Soft UI Design PRO is ready to help you create stunning websites and webapps.

• 👉 Soft UI Design PRO Flask - Product page
• 👉 Soft UI Design PRO Flask - LIVE Demo
• 👉 Complete documentation - Learn how to use and update the product

Features

• Up-to-date dependencies
• Database: MySql, SQLite
• DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
• Authentication
  • Session-Based authentication
  • Social Login (optional) for Github & Twitter
• User profiles
  • Extended profile, Self-Deletion

✨ Start the app in Docker

Step 1 - Download the code and unzip the sources (requires a purchase).

$ # Get the code
$ unzip flask-soft-ui-design-enh.zip
$ cd flask-soft-ui-design-enh

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 a new .env file using sample env.sample

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
• MYSQL credentials
  • DB_ENGINE, default value = mysql
  • DB_NAME, default value = appseed_db
  • DB_HOST, default value = localhost
  • DB_PORT, default value = 3306
  • DB_USERNAME, default value = appseed_db_usr
  • DB_PASS, default value = pass
• OAuth via Github
  • GITHUB_ID=<GITHUB_ID_HERE>
  • GITHUB_SECRET=<GITHUB_SECRET_HERE>
• OAuth via Twitter
  • TWITTER_ID=<TWITTER_ID_HERE>
  • TWITTER_SECRET=<TWITTER_SECRET_HERE>

✨ Set up the MySql Database

Note: Make sure your Mysql server is properly installed and accessible.

Step 1 - Create the MySql Database to be used by the app

• Create a new MySql database
• Create a new user and assign full privilegies (read/write)

Step 2 - Edit the .env to match your MySql DB credentials. Make sure DB_ENGINE is set to mysql.

• DB_ENGINE : mysql
• DB_NAME : default value = appseed_db
• DB_HOST : default value = localhost
• DB_PORT : default value = 3306
• DB_USERNAME: default value = appseed_db_usr
• DB_PASS : default value = pass

Here is a sample:

# .env sample

DEBUG=False                 # False enables the MySql Persistence

DB_ENGINE=mysql             # Database Driver
DB_NAME=appseed_db          # Database Name
DB_USERNAME=appseed_db_usr  # Database User
DB_PASS=STRONG_PASS_HERE    # Password 
DB_HOST=localhost           # Database HOST, default is localhost 
DB_PORT=3306                # MySql port, default = 3306 

✨ How to use it

Download the code and unzip the sources (requires a purchase).

$ # Get the code
$ unzip flask-soft-ui-design-enh.zip
$ cd flask-soft-ui-design-enh

👉 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
   |    |         |-- page-404.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
   |
   |-- ************************************************************************

---

Soft UI Design PRO Flask - Seed Project generated by AppSeed Generator.

flask-soft-ui-design-pro's Issues

Incorrect footer spacing on basic and simple sign up and sign in pages

The footer spacing is incorrect on basic and simple sign up and sign in pages.

You can see an example on the basic sign up page:
https://flask-soft-ui-design-pro.appseed-srv1.com/page-sign-up-basic.html

Nav bar location is wrong on 403 and 404 pages

The nav bar sits too low on the 403 and 404 pages. See https://flask-soft-ui-design-pro.appseed-srv1.com/page-404.html and https://flask-soft-ui-design-pro.appseed-srv1.com/page-403.html for reference.

Keep main nav menu in center even when removing "Buy Now" button

In navigation.html, I would like to remove the "Buy Now" gradient button on the right hand side while still keeping the "Help" (or other main navigation items when a user is logged in) in the center of the nav bar. Right now it appears to be centering in the open space, rather than the true center of the nav bar. Can you please point out what needs to be changed and where to make this happen? Thanks!