Skip to content

Flask template for quick starting your flask project, user authentication included

License

Notifications You must be signed in to change notification settings

YAS-opensource/flask-boilerplate

Repository files navigation

Flask Boilerplate

Actions Status codecov Maintainability Codacy Badge

A boilerplate made for kick-starting your next flask project, with ready to go authentication(using JWT) module and a base REST api module. Godspeed!

  • Out of the box Authentication with JWT
  • And extendable base module to create new API endpoints with ease. Supported methods are: GET, POST
  • Out of the box Authentication checker decorator that you can add to any endpoint!

Installing dependencies

  • Install and run dependencies on virtualenv:

    pipenv install
    pipenv run
  • Migrate the database:

    make create_db
    make db_init
    make db_migrate
  • Upgrade the database:

    make db_upgrade
  • Add a .env file. One is given here as an example.env, you must not use this file as is, always edit the secret key to a new secure key, when you develop your application. Modify other variables as per your necessary configuration for your own project.

Usage

If you want to run the project on a different port, for example 8000, do this:

python manage.py runserver 8000
  • To run tests:

    make test

Documentations