john0isaac/azure-flask-mysql-flexible-appservice

Web app using Python Flask backend, set up for deployment to Azure App Service with Azure MySQL Flexible Server.

page_type	languages	products	urlFragment	name	description
sample	azdeveloper python bicep html css scss	azure azure-app-service azure-mysql	azure-flask-mysql-flexible-appservice	Deploy Flask Application with MySQL on Azure App Service (Python)	This project deploys a web application for a space travel agency using Flask with Python, and is set up for easy deployment with the Azure Developer CLI.

Deploy Flask Application with MySQL via Azure App Service

This project deploys a web application for a space travel agency using Flask. The application can be deployed to Azure with Azure App Service using the Azure Developer CLI.

Opening the project

This project has Dev Container support, so it will be setup automatically if you open it in GitHub Codespaces or in local VS Code with the Dev Containers extension.

If you're not using one of those options for opening the project, then you'll need to:

1. Start up a local MySQL server, create a database for the app, and set the following environment variables according to your database configuration.

   export MYSQL_HOST=127.0.0.1
   export MYSQL_PORT=3306
   export MYSQL_DATABASE=<YOUR DATABASE>
   export MYSQL_USER=<YOUR USERNAME>
   export MYSQL_PASS=<YOUR PASSWORD>

2. Create a Python virtual environment and activate it.

3. Install production requirements:

   python3 -m pip install -r src/requirements.txt

4. Install the app as an editable package:

   python3 -m pip install -e src

5. Apply database migrations and seed initial data:

   python3 -m flask --app src.flaskapp db upgrade --directory src/flaskapp/migrations
   python3 -m flask --app src.flaskapp seed --filename src/seed_data.json

Running locally

If you're running the app inside VS Code or GitHub Codespaces, you can use the "Run and Debug" button to start the app.

python3 -m flask --app src.flaskapp run --debug --reload --port=5000

Running tests

1. Install the development requirements:

   python3 -m pip install -r requirements-dev.txt
   python3 -m playwright install chromium --with-deps

2. Run the tests:

   python3 -m pytest

Deployment

This repo is set up for deployment on Azure via Azure App Service.

Steps for deployment:

1. Sign up for a free Azure account and create an Azure Subscription.

2. Install the Azure Developer CLI. (If you open this repository in Codespaces or with the VS Code Dev Containers extension, that part will be done for you.)

3. Login to Azure:

   azd auth login

4. Provision and deploy all the resources:

   azd up

   It will prompt you to provide an azd environment name (like "myapp"), select a subscription from your Azure account, and select a location (like "eastus"). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location can help, as there may be availability constraints for some of the resources.

5. When azd has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the front page of the app! 🎉

6. When you've made any changes to the app code, you can just run:

   azd deploy

CI/CD pipeline

This project includes a GitHub workflow for deploying the resources to Azure on every push to main. That workflow requires several Azure-related authentication secrets to be stored as GitHub action secrets. To set that up, run:

azd pipeline config

azure-flask-mysql-flexible-appservice's Issues

Add devcontainer env vars file + check for the dotenv requiremnts

https://github.com/john0isaac/msdocs-flask-mysql-sample-app/blob/main/.env.sample.devcontainer

Add instructions to run devcontainer

https://github.com/john0isaac/msdocs-flask-mysql-sample-app/tree/main?tab=readme-ov-file#run-the-sample