ajthr / flask-boilerplate

Flask API Boilerplate including MySQL as database, custom commands for easy management, better structure and dockerized. Based on Python, Flask, MySQL, Docker.

flask-boilerplate

Flask Boilerplate for app and api

Features

• Custom commands for ease of use
  • make - Adds a migrations folder to the application.
  • migrate - Generates and Applies migration to the database after database is ready to accept connections.
  • test - Run tests for the application.
  • create-app - Create an app with a predefined structure.
  • deploy - Run app with gunicorn
• Mysql for DB
  • Mysql is configured and ready to be used.
• Project structure
  • Related files can be grouped.
  • Components can be isolated.
• Dockerized

Quick Start

First, install cookiecutter if you don't already have it:

pip3 install cookiecutter

Second, install docker-compose if you don't already have it:

docker-compose installation official docs.

Then, in the directory you want your project to live:

cookiecutter gh:ajthr/flask-boilerplate

Input Variables

• project_name [default flask boilerplate]
• project_slug [default flask_boilerplate] - this is your project directory
• mysql_user [default admin] - whether to use any external database like mongodb atlas
• mysql_password [default password]
• mysql_root_password [default root_password]
• mysql_database [default flask_boilerplate]
• secret_key [default super_secret]

Develop

Change into your project directory and run:

docker-compose up -d --build

This will build and run the docker containers.

It may take a while to build the first time it's run since it needs to fetch all the docker images.

Once you've built the images once, you can simply use regular docker-compose commands to manage your development environment, for example to start your containers:

docker-compose up -d

Once this finishes you can navigate to the localhost port, you should see the slightly modified create-react-app page.

Testing

To run test for the template, run:

chmod +x ./test.sh
sudo ./test.sh

To run test for api, run

docker-compose run --rm api sh -c "flask test"

MIT License