This project is aimed at creating initial boiler plate for any flask restful api.

• It provides a basic CRUD functionality for user and product models
• It also has basic authentication and authorization for users

Flask API Template

• Project Setup
  • Clone The Repo
• Run the app locally using docker
  • Install Docker
  • Install make
  • Run the app
• Run the app locally without docker``
  • Install PostgreSQL
  • Create a Virtual Environment
  • Activate the virtual environment
  • Install the dependencies
  • Create a .env file
  • Run Database migrations
  • Run Application
  • Test the API
  • Checkout Application Api docs

Follow these steps to have a local running copy of the app.

git clone https://github.com/Mubangizi/flask-rest-api-template.git

If master is not up to date, git checkout develop. However, note that code on develop could be having some minor issues to sort.

Here's a great resource to check out:

How To Install and Use Docker on Ubuntu 18.04

sudo apt-get install make

To start the app, run

make start

Application should be running on port 5000

Here's a great resource to check out:

How To Install and Use PostgreSQL

Create a development database and call it mobile_shop_db.

create virtual enviroment called venv in the root of the project.

Run

virtualenv venv

Run

. venv/bin/activate

Make sure you have pip installed on your machine.

pip install -r requirements.txt

Create a .env file (which defines the environment variables used) at the root of the app.

Add the following details, customizing as needed.

export FLASK_APP=server.py
export DATABASE_URI=postgresql:///flask_app_db
export FLASK_APP_SECRET=qY2i691SX2sEuZ7LUjY480RS48mw5qCeUiyV0i0vzmg
export FLASK_ENV=development
export FLASK_RUN_PORT=5000

Run migrations for the database. This will create the tables for the models in the database .

python manage.py db upgrade

If you make changes to the models, you need to create migrations for the changes by running python manage.py db migrate and then python manage.py db upgrade to add the changes to the database.

Run the application with this command

flask run

Through your browser go to link localhost:<flask_port>/.

Through your browser go to link localhost:<flask_port>/apidocs.