flask-postgres-boilerplate

a flask api boilerplate with authentication backed by postgres

app dependencies

• flask: python web framework
• flask-sqlalchemy: sql toolkit / ORM
• flask-migrate: sql migrations
• flask-login: authentication helpers for flask
• flasgger: used to generate the swagger documentation
• apispec: required for the integration between marshmallow and flasgger
• postgres: database

system dependencies

you should only need to install or set these up once

python environment

• brew install pipenv
• brew install pyenv
• brew install pyenv-virtualenv
• optional for oh-my-zsh:

  • git clone https://github.com/mattberther/zsh-pyenv ~/.oh-my-zsh/custom/plugins/zsh-pyenv

  • update .zshrc

    plugins=(
        ...
        zsh-pyenv
        pipenv
    )

postgres

• install with homebrew

  brew install postgresql@14

• start

  brew services start postgresql@14

• run config script

  make db-setup

starting the application

0. checkout lastest from remote repository

1. install/update requirements

   pipenv install

2. check for and run migrations

   pipenv run pythom -m flask db check
   pipenv run python -m flask db upgrade # only if necessary

3. start the server

   pipenv run python -m flask run

Tests

The code is covered by tests, to run the tests please execute

pipenv run python -m unittest