Open-Source
seed project generated by AppSeed in Flask Framework on top of Pixel Lite design. Pixel
is a free and open-source Bootstrap 5
based UI Kit featuring over 80 fully coded UI elements and example pages that will help you prototype and build a website for your next project.
Email
& Discord
🚀 Built with App Generator, Timestamp:
2022-05-31 08:12
Up-to-date dependencies
Database
: SQLite
, MySql
SQLite
DB Tools
: SQLAlchemy ORM, Flask-Migrate (schema migrations)Flask-Minify
(page compression)Deployment
CI/CD
flow via Render
video presentation
)Docker
👉 Step 1 - Download the code from the GH repository (using
GIT
)
$ git clone https://github.com/app-generator/flask-pixel.git
$ cd flask-pixel
👉 Step 2 - Start the APP in
Docker
$ docker-compose up --build
Visit http://localhost:5085
in your browser. The app should be up & running.
Download the code
$ git clone https://github.com/app-generator/flask-pixel.git
$ cd flask-pixel
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/
.
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/
.
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
flask run
registration
page and create a new user:
http://127.0.0.1:5000/register
sign in
page and authenticate
http://127.0.0.1:5000/login
In order to customize the UI (primary/seconday colors), follow this setup:
apps/static/assets
pnpm i
gulp
NOTE: the above setup was tested using:
v16.15.0
2.3.0
, LOCAL 4.0.2
v8.6.0
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
|
|-- ************************************************************************
For more components, pages and priority on support, feel free to take a look at this amazing starter:
Pixel PRO is a premium design crafted by the Themesberg
agency on top of Bootstrap 5 Framework. Pixel is a premium Bootstrap 5 UI Kit
that provides 1000+ components, 50+ sections and 35 example pages including a fully fledged user dashboard.
Flask Pixel Lite - Open-source starter generated by App Generator.