Skip to content

Latest commit

 

History

History
191 lines (163 loc) · 5.17 KB

RELEASE.md

File metadata and controls

191 lines (163 loc) · 5.17 KB

Flask Boilerplate

Flask boilerplate inspired by The Flask Mega-Tutorial by Miguel Grinberg

August 9, 2019 Release Notes

  • V0.5

This version is implementing all users features

August 9, 2019 Release Notes

  • V0.4

This version is about testing. After integrating Flask Admin and Debug Tool Bar, I focused on the test coverage in order to have 100%.

Features added :

  • Debug Tool Bar
  • Flask Admin

New tree :

.
├── .env
├── .gitignore
├── LICENSE.md
├── README.md
├── RELEASE.md
├── app
│   ├── __init__.py
│   ├── admin.py
│   ├── cli.py
│   ├── fake.py
│   ├── main
│   │   ├── __init__.py
│   │   ├── errors.py
│   │   ├── forms.py
│   │   └── views.py
│   ├── models.py
│   ├── static
│   │   └── styles.css
│   └── templates
│       ├── 404.html
│       ├── 500.html
│       ├── base.html
│       └── index.htm
├── config.py
├── data-dev.sqlite
├── migrations
│   ├── README
│   ├── alembic.ini
│   ├── env.py
│   ├── script.py.mako
│   └── versions
│       └── 308e36742345_.py
├── requirements.txt
├── run.py
├── tests
│   ├── __init__.py
│   ├── test_basics.py
│   ├── test_cli.py
│   ├── test_client.py
│   ├── test_db.py
│   ├── test_role_model.py
│   └── test_user_model.py
└── tree

7 directories, 37 files

August 1, 2019 Release Notes

  • V0.3

As i needed a real push, this release has a lot of new features based on Miguel Grinbergs's tutorial. Most of the new features are documented in the files or in the README.me.

Features added :

  • Database
  • Migrate
  • Test
  • Cli
  • Coverage

New tree :

├── .env
├── .gitignore
├── LICENSE.md
├── README.md
├── RELEASE.md
├── app
│   ├── __init__.py
│   ├── cli.py
│   ├── main
│   │   ├── __init__.py
│   │   ├── errors.py
│   │   ├── forms.py
│   │   └── views.py
│   ├── models.py
│   ├── static
│   │   └── styles.css
│   └── templates
│       ├── 404.html
│       ├── 500.html
│       ├── base.html
│       └── index.htm
├── config.py
├── data-dev.sqlite
├── migrations
│   ├── README
│   ├── alembic.ini
│   ├── env.py
│   └── script.py.mako
├── requirements.txt
├── run.py
├── tests
│   ├── __init__.py
│   ├── test_basics.py
│   └── test_db.py
└── tree

6 directories, 30 files

July 18, 2019 Release Notes

  • V0.2

Features added :

  • Bootstrap
  • WTForms
  • Error handler, 404, 500
  • Custom styles.css
  • Templates
  • Testing module

New tree :

├── LICENSE.md
├── README.md
├── config.py
├── requirements.txt
├── run.py
├── app
│   ├── __init__.py
│   ├── main
│   │   ├── __init__.py
│   │   ├── errors.py
│   │   ├── forms.py
│   │   └── views.py
│   ├── static
│   │   └── styles.css
│   └── templates
│       ├── 404.html
│       ├── 500.html
│       ├── base.html
│       └── index.htm
└── tests
    ├── __init__.py
    ├── test_basics.py
    └── test_db.py

July 17, 2019 Release Notes

  • V0.1
    This first version is the simplest Flask web server including the organization of the files and folders for bigger projects.

Stack, Extensions and Features : - [X] Python 3.7.4 - [X] Flask 1.1.1 - [X] python-dotenv

Files Description
config.py This file contains most of the configuration variables that your app needs.
run.py This is the file that is invoked to start up a development server. It gets a copy of the app from your package and runs it. This won’t be used in production, but it will see a lot of mileage in development.
requirements.txt This file lists all of the Python packages that your app depends on. You may have separate files for production and development dependencies.
/app/ This is the package that contains your application.
/app/__init__.py This file initializes your application and brings together all of the various components.
/app/main/__init__.py Set the forlder using Blueprint
/app/main/views.py This is where the routes are defined.
/app/static/ This directory contains the public CSS, JavaScript, images and other files that you want to make public via your app. It is accessible from app.com/static/ by default.
app/static/styles.css Main custom CSS file.
/app/templates/ This is where you’ll put the Jinja2 templates for your app.
/app/templates/index.htm File used by the app as an index