Skip to content

This is a simple boilerplate flask app, for anyone who wants to get an app running in no time

License

Notifications You must be signed in to change notification settings

mustaphee/flask-simple-boilerplate

Repository files navigation

Flask Simple Boilerplate: For everyone

This is probably the easiest and the most documented flask boilerplate app. It uses an MVC folder structure and pattern which is a bonus if you're used to MVC pattern ( you can easily change it if you're not an MVC fan ). It has all the setup done for you, so you only have to focus on writing your business logic. It also has installed all the basic libraries installed for you already.

Feature Support

Flask simple boilerplate is easy, scalable, ready to use and deploy

  • Get your app ready in no time.
  • MVC architecture.
  • Prebundled error pages and serves automatically.
  • Well unit tested.
  • Integrate well with MySQL and PostgreSQL.
  • Deploy in one-click to Heroku.

Flask simple boilerplate officially supports Python 3 for now, Python 2 support will be added later.

Installation

To use, simply download, fork or clone this repository, then:

$ git clone https://github.com/mustaphee/flask-simple-boilerplate

$ cd flask-simple-boilerplate

$ pip install -r requirements.txt

$ python run_server.py

✨🍰

Dont forget to add .env file to your root folder (Rename .env-example to .env with your dev configurations)

Run Test

To run the test, run:

$ python run_test.py✨

Dependencies

  • Flask
  • Flask-Migrate
  • Flask-Psycopg2
  • PyMySQL
  • Flask-SQLAlchemy
  • Pytest
  • coverage
  • Bootstrap
  • jQuery

How to Contribute

I would love any contribution which would make this project. Just fork this repo, and create a pull request and it will be reviewed and merge, simple as AB...

About

This is a simple boilerplate flask app, for anyone who wants to get an app running in no time

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published