Flask Pixel

Overview:

Flask Pixel Lite is an open-source Flask app built on a modern design. It is a free and open-source Bootstrap 5 UI Kit that provides over 80 fully coded UI elements and example pages to help users prototype and build websites for their projects. It offers up-to-date dependencies and supports databases like SQLite and MySql. The app also provides session-based authentication, forms validation, and features like Docker and Flask-Minify for deployment and page compression. Overall, Flask Pixel Lite is a comprehensive solution for developers looking to create websites using Flask and Bootstrap.

Features:

• Up-to-date dependencies: Flask Pixel Lite uses the latest dependencies to ensure compatibility and security.
• Database: Supports SQLite and MySql databases.
• Silent fallback to SQLite: Automatically falls back to SQLite if MySql is not available.
• DB Tools: Implements SQLAlchemy ORM and Flask-Migrate for schema migrations.
• Session-Based authentication: Includes authentication capabilities via flask_login and forms validation.
• Docker: Provides Docker support for deployment.
• Flask-Minify: Supports page compression for optimized performance.

Installation:

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

git clone <repository_url>

Step 2 - Start the APP in Docker

docker-compose up

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

Manual Build Set Up for Unix, MacOS

1. Install modules via VENV:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

2. Set Up Flask Environment:

export FLASK_APP=run.py
export FLASK_ENV=development

3. Start the app:

flask run

The app runs at http://127.0.0.1:5000/.

Set Up for Windows

1. Install modules via VENV (Windows):

python3 -m venv venv
venv\Scripts\activate
pip install -r requirements.txt

2. Set Up Flask Environment:

set FLASK_APP=run.py
set FLASK_ENV=development

3. Start the app:

flask run

The app runs at http://127.0.0.1:5000/.

Create Users By default, the app redirects guest users to authenticate. Follow these steps to access private pages:

1. Start the app via flask run.
2. Access the registration page and create a new user: http://127.0.0.1:5000/register.
3. Access the sign-in page and authenticate: http://127.0.0.1:5000/login.

CSS/SCSS Update To customize the UI colors, follow these steps:

1. Navigate to apps/static/assets.
2. Edit the SCSS files.
3. Install dependencies using PNPM:

pnpm i

4. Recompile the SCSS files with Gulp:

gulp

Please note that the above setup was tested using:

• Node v16.15.0
• Gulp CLI 2.3.0 (LOCAL 4.0.2)
• PNPM v8.6.0

Summary:

Flask Pixel Lite is an open-source Flask app that provides a modern design and a comprehensive set of features for building websites. With its support for Bootstrap 5, it offers over 80 fully coded UI elements and example pages. The app supports up-to-date dependencies, provides database compatibility, and offers functionalities like session-based authentication, Docker deployment, and page compression. Its simple installation process and customization options make it a valuable tool for developers looking to create websites using Flask and Bootstrap.