ebreton / flask-bootstrap

basic scaffolding for flask applications, embedding Hello World and heroku deployment

Offer yourself a head start
for your next flask app

Looking for something lighter ?

Like a bootstrap for a simple new python project with a simple CLI ? Check PyBootstrap...

Main features

• Dev friendly: a Makefile will allow to quickly setup everything with make init-venv
• Multiple runners:
  • Ran locally with hot reloading of the code with make deploy
  • Or still locally, but a step closer to production with make gunicorn
  • Or emulating Heroku context with make heroku
  • Or even hosted on Heroku with make deploy
  • All this... with or without DB 🎈
• Support for DB thanks to flask-SQLalchemy... but... not mandatory.
• Configuration through environement variables in a .env file: mainly for Heroku, and storage type.
• Automated testing and deployment: connected to Travis and Codecov, relies on Heroku toolbelt for deployment.
• Support for Bootstrap3, thanks to flask-bootstrap
• Easy creation of your navigation with flask-nav
• Comes with a basic frontend, from the bootstrap example 'sticky footer with fixed navbar'

You said 'optionnal' DB?

If persistent storage is needed: will use postgreSQL with Heroku by default. Also works without DB, in which case the data will be stored in memory, until next restart of the application

Something is missing ?

Head to githup issues and submit one ! Be sure to have a look at the CONTRIBUTING.md guide before

Install and Usage

Check out INSTALL.md for more details

Changelog

All notable changes to this project are documented in CHANGELOG.md.

Contribution

Check out CONTRIBUTING.md for more details

As well as our CODE_OF_CONDUCT.md, where we pledge to making participation in our project and our community a harassment-free experience for everyone