Home

Awesome

cookiecutter-flask-minimal

A microtemplate for a microframework.

This is a minimalist's production-ready Flask project template:

Now upgraded to Flask 3 !

If you look for the Flask 2 version, check out the flask2 branch. It is not actively maintained but is tested and known to work with the latest Flask 2 release (2.3.3 as of the time of this writing).

Looking for a feature-complete, yet minimalistic web app starter kit? Check out cookicutter-flask-boring.

Usage

Install cookiecutter:

pip install --user cookiecutter

Create your application from this template:

cookiecutter https://github.com/candidtim/cookiecutter-flask-minimal.git

All set! Run the application:

cd yourapplication
make run

And then open it at http://127.0.0.1:5000/

Features

Included:

Not included:

Contributions

... are welcome! Feel free to create a pull request to fix bugs or keep up to date.

If you think some additional feature is indispensable, feel free to create an issue or a pull request, but bare in mind that the goal of this template is to stay a "minimal" one. If you would like to add a feature, maybe best way to do so is to make it optional and off by default then. One can use cookiecutter's choice variables, and, ultimately, hooks, in order to create an optional feature.

If you do a change, use make test from root directory to test the updated template.

Attributions

Configuration of this entire project template is based on Flask documentation. Please, note however, that this template is not guaranteed to follow Flask documentation precisely.