Giter VIP home page Giter VIP logo

flask-boilerplate's Introduction

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

flask-boilerplate's People

Contributors

cinder-star avatar codacy-badger avatar dependabot[bot] avatar geektrovert avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

flask-boilerplate's Issues

Make a generic query class

A generic query class is needed to make both complex and simple queries using SqlAlchemy.
The current structure has limitations of only executing simple queries.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.