Flitedocs

Installation

Flite is a powerful Flask project generator that helps developers quickly bootstrap Flask applications with modern project structures and best practices.

Install via pip

Not available yet on PyPI

Or install from source

git clone https://github.com/Artbyo3/flite.git
cd flite
pip install -e .

Quick Start

Get up and running with Flite in just a few commands:

Create a new Flask project

flite create my-awesome-app
cd my-awesome-app
flite run

🎉 That's it!

Your Flask application is now running at http://localhost:5000 with a modern project structure, beautiful UI, and all the essentials you need to start building.

Features

⚡

Lightning Fast

Generate a complete Flask project structure in seconds

🎨

Modern UI

Beautiful, responsive design with 3D effects and animations

📁

Best Practices

Follows Flask best practices and project organization

🔧

Configurable

Customize templates, styles, and project structure

📦

Dependencies

Automatic dependency management with requirements.txt

🚀

Production Ready

Includes configuration for development and production

Commands

Flite provides several commands to help you manage your Flask projects:

`flite create <project-name>`

Creates a new Flask project with the specified name

flite create my-blog
flite create ecommerce-site
flite create api-backend

`flite init`

Initialize Flite in an existing directory

mkdir my-project
cd my-project
flite init

`flite add <component>`

Add components to existing projects

flite add auth      # Add authentication
flite add api        # Add API endpoints
flite add admin      # Add admin panel
flite add database   # Add database models

`flite serve`

Start the development server with auto-reload

flite serve --port 8080
flite serve --debug
flite serve --host 0.0.0.0

Examples

Here are some common use cases and examples:

Creating a Blog

Complete blog setup

# Create the project
flite create my-blog

# Add blog features
cd my-blog
flite add auth
flite add database

# Start developing
flask run

Building an API

REST API setup

# Create API project
flite create my-api --template api

# Add database and authentication
flite add database
flite add auth

# Add API documentation
flite add docs

# Run the API
flask run --port 5000

E-commerce Site

E-commerce setup

# Create e-commerce project
flite create shop --template ecommerce

# Add all necessary components
flite add auth
flite add database
flite add payment
flite add admin

# Start the application
flask run

Configuration

Flite projects come with sensible defaults, but you can customize them:

Project Structure

my-project/
├── app/
│   ├── __init__.py
│   ├── routes.py
│   ├── models.py
│   ├── static/
│   │   ├── css/
│   │   ├── js/
│   │   └── images/
│   └── templates/
│       ├── base.html
│       └── index.html
├── config.py
├── requirements.txt
└── run.py

Environment Variables

# .env file
FLASK_APP=run.py
FLASK_ENV=development
SECRET_KEY=your-secret-key-here
DATABASE_URL=sqlite:///app.db

Troubleshooting

❌ ModuleNotFoundError: No module named 'flask'

Solution: Make sure you have Flask installed in your virtual environment:

pip install flask
# or
pip install -r requirements.txt

❌ Port already in use

Solution: Use a different port or kill the process using the port:

flask run --port 8080
# or
lsof -ti:5000 | xargs kill -9

❌ Template not found

Solution: Make sure your templates are in the correct directory and Flask can find them:

# Check your app structure
ls -la app/templates/
# Make sure Flask app is initialized correctly
python -c "from app import app; print(app.template_folder)"

Flite Documentation

Table of Contents