flask-starter

A flask developement starter kit

Installation

for stable version

• pip install flask-starter

for current_version

• pip install git+https://github.com/Agent-Hellboy/flask-starter.git

using

Open the terminal and type

• flask-starter-project create your-project-name
• If you want to create a new project with an inbuilt auth and admin interface for your use create
• If you want to add the flask-starter to your existing project use add
• cd your-project-name
• Create the virtualenv and install the requirements which is there in your-project-name
• run python3 server.py
• You can use flask-starter-project create testapp --mode prod if you want a production-ready app

Project Structure

The generated project follows a clean and organized structure:

your-project-name/
├── app/
│   ├── __init__.py          # App initialization and configuration
│   ├── models.py            # Database models
│   ├── views.py             # Route handlers and views
│   ├── forms.py             # Form definitions and validation
│   ├── extension.py         # Flask extensions (SQLAlchemy, LoginManager, etc.)
│   ├── libs/                # Custom business logic and utilities
│   └── templates/           # Jinja2 templates
│       ├── layout.html      # Base template
│       ├── home.html        # Home page
│       ├── login.html       # Login page
│       ├── register.html    # Registration page
│       └── profile.html     # User profile page
├── tests/                   # Test directory
│   ├── __init__.py
│   ├── conftest.py          # Test configuration and fixtures
│   └── test_views.py        # View tests
├── requirements.txt         # Project dependencies
├── pyproject.toml          # Project configuration and metadata
└── server.py               # Application entry point

Key Components: - app/: Main application package

• models.py: Defines database models (User, etc.)
• views.py: Contains route handlers and view logic
• forms.py: Defines form classes and validation logic
• extension.py: Initializes Flask extensions
• templates/: HTML templates with Jinja2

• tests/: Test suite with pytest
• server.py: Application entry point with development server
• pyproject.toml: Project configuration including: - Dependencies and development tools - Code formatting settings (black, isort) - Linting configuration (flake8) - Test configuration (pytest)

You will have the following routes by default

      Endpoint           Methods    Rule
      -----------------  ---------  ---------------------------------
      admin.index        GET        /admin/
      admin.static       GET        /admin/static/<path:filename>
      main.home          GET        /
      main.login         GET, POST  /login
      main.logout        GET        /logout
      main.profile       GET        /profile
      main.register      GET, POST  /register
      static             GET        /static/<path:filename>
      user.action_view   POST       /admin/user/action/
      user.ajax_lookup   GET        /admin/user/ajax/lookup/
      user.ajax_update   POST       /admin/user/ajax/update/
      user.create_view   GET, POST  /admin/user/new/
      user.delete_view   POST       /admin/user/delete/
      user.details_view  GET        /admin/user/details/
      user.edit_view     GET, POST  /admin/user/edit/
      user.export        GET        /admin/user/export/<export_type>/
      user.index_view    GET        /admin/user/



- You can access the admin interface by adding `/admin` to your base URL

- Just write core logic in libs and present your prototype

Development Tools

The project includes several development tools configured in pyproject.toml:

• Code Formatting: - Black (line length: 88) - isort (compatible with Black)
• Linting: - Flake8 (max line length: 88) - Ignores E203 for Black compatibility
• Testing: - pytest for test execution - pytest-cov for coverage reporting

To run tests with coverage:

• pytest --cov=app --cov-report=term-missing

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.