Match the other samples

Author: pamelafox

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+FROM mcr.microsoft.com/devcontainers/python:3.12-bullseye
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends postgresql-client \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*

.devcontainer/Dockerfile_dev

@@ -5,7 +5,7 @@
 
     // Update the 'dockerComposeFile' list if you have more compose files or use different names.
     // The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
-    "dockerComposeFile": "docker-compose_dev.yml",
+    "dockerComposeFile": "docker-compose.yml",
     // The 'service' property is the name of the service for the container that VS Code should
     // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
     "service": "app",
@@ -16,6 +16,9 @@
         "8000": {"label": "frontend web port", "onAutoForward": "notify"},
         "5432": {"label": "PostgreSQL Port", "onAutoForward": "silent"}
     },
+    "features": {
+        "ghcr.io/azure/azure-dev/azd:latest": {}
+    },
     "customizations": {
         "vscode": {
             "extensions": [
@@ -42,10 +45,6 @@
                 }
             }
         }
-    },
-    "features": {
-        "ghcr.io/azure/azure-dev/azd:latest": {}
-    },
-    "postCreateCommand": "pip install -e src &&  python3 src/fastapi_app/seed_data.py"
+    }
 }
 

.devcontainer/devcontainer.json

@@ -1,42 +1,37 @@
-version: '3'
 services:
-  db:
-    image: postgres:14
-
-    environment:
-      POSTGRES_USER: postgres
-      POSTGRES_DB: relecloud
-      POSTGRES_PASSWORD: postgres
-
-    restart: unless-stopped
-
-    volumes:
-      - postgres-data:/var/lib/postgresql/data
-
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres -d relecloud"]
-      interval: 5s
-      timeout: 5s
-      retries: 5
 
   app:
     build:
       context: ..
-      dockerfile: ./.devcontainer/Dockerfile_dev
+      dockerfile: ./.devcontainer/Dockerfile
     depends_on:
       db:
         condition: service_healthy
-    network_mode: service:db
-    environment:
-      POSTGRES_USERNAME: postgres
-      POSTGRES_DATABASE: relecloud
-      POSTGRES_HOST: db
-      POSTGRES_PASSWORD: postgres
 
+    volumes:
+      - ..:/workspace:cached
+  
+    # Overrides default command so things don't shut down after the process ends.
     command: sleep infinity
 
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:db
+
+  db:
+    image: postgres:14
+    restart: unless-stopped
     volumes:
-      - ..:/workspace:cached
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: app
+      POSTGRES_USER: app_user
+      POSTGRES_PASSWORD: app_password
+
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres -d relecloud"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
 
 volumes:
   postgres-data:

.devcontainer/docker-compose_dev.yml .devcontainer/docker-compose.yml.devcontainer/docker-compose_dev.yml renamed to .devcontainer/docker-compose.yml

@@ -1,5 +1,5 @@
-POSTGRES_DATABASE=<database name>
-POSTGRES_HOST=<database-hostname>
-POSTGRES_PORT=5432
-POSTGRES_USERNAME=<db-user-name>
-POSTGRES_PASSWORD=<db-password>
+DBNAME=app
+DBHOST=db
+DBPORT=5432
+DBUSER=app_user
+DBPASS=app_password

.env.sample

@@ -22,42 +22,36 @@ description: This project deploys a restaurant review web application using Fast
 
 This project deploys a web application for a restaurnant review site using FastAPI. The application can be deployed to Azure with Azure App Service using the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview).
 
-## Opening the project
 
-This project has [Dev Container support](https://code.visualstudio.com/docs/devcontainers/containers), so it will be setup automatically if you open it in Github Codespaces or in local VS Code with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
+## Run the sample
 
-If you're *not* using one of those options for opening the project, then you'll need to:
+This project has a [dev container configuration](.devcontainer/), which makes it easier to develop apps locally, deploy them to Azure, and monitor them. The easiest way to run this sample application is inside a GitHub codespace. Follow these steps:
 
-1. Start up a local PostgreSQL server, create a database for the app, and set the following environment variables according to your database configuration.
+1. Fork this repository to your account. For instructions, see [Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).
 
-```shell
-export POSTGRES_HOST=localhost
-export POSTGRES_PORT=5432
-export POSTGRES_DATABASE=<YOUR DATABASE>
-export POSTGRES_USERNAME=<YOUR USERNAME>
-export POSTGRES_PASSWORD=<YOUR PASSWORD>
-```
+1. From the repository root of your fork, select **Code** > **Codespaces** > **+**.
 
-1. Create a [Python virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) and activate it.
+1. In the codespace terminal, run the following commands:
 
-1. Install production requirements:
+    ```shell
+    # Create .env with environment variables
+    cp .env.sample .env
 
-    ```sh
+    # Install requirements
     python3 -m pip install -r src/requirements.txt
-    ```
-
-1. Install the app as an editable package:
 
-    ```sh
+    # Install the app as an editable package
     python3 -m pip install -e src
-    ```
-
-1. Apply database migrations:
 
-    ```sh
+    # Run database migrations
     python3 src/fastapi_app/seed_data.py
+
+    # Start the development server
+    python3 -m uvicorn fastapi_app:app --reload --port=8000
     ```
 
+1. When you see the message `Your application running on port 8000 is available.`, click **Open in Browser**.
+
 ## 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.

README.md

@@ -182,15 +182,7 @@ resource web 'Microsoft.Web/sites@2022-03-01' = {
     properties: {
       SCM_DO_BUILD_DURING_DEPLOYMENT: 'true'
       AZURE_POSTGRESQL_CONNECTIONSTRING: 'dbname=${pythonAppDatabase.name} host=${postgresServer.name}.postgres.database.azure.com port=5432 sslmode=require user=${postgresServer.properties.administratorLogin} password=${databasePassword}'
-      POSTGRES_HOST: '${postgresServer.name}.postgres.database.azure.com'
-      POSTGRES_DATABASE: pythonAppDatabase.name
-      POSTGRES_PORT: '5432'
-      POSTGRES_USERNAME: postgresServer.properties.administratorLogin
-      POSTGRES_PASSWORD: databasePassword
-      POSTGRES_SSL: 'require'
       SECRET_KEY: secretKey
-      // FLASK_DEBUG: 'False'
-      //Added for Azure Redis Cache
       AZURE_REDIS_CONNECTIONSTRING: 'rediss://:${redisCache.listKeys().primaryKey}@${redisCache.name}.redis.cache.windows.net:6380/0'
     }
   }

infra/resources.bicep

@@ -3,27 +3,33 @@
 from datetime import datetime
 from urllib.parse import quote_plus
 
+from dotenv import load_dotenv
 from sqlmodel import Field, SQLModel, create_engine
 
 sql_url = ""
-if os.getenv("AZURE_POSTGRESQL_CONNECTIONSTRING"):
+if os.getenv("WEBSITE_HOSTNAME"):
+    print("Connecting to Azure PostgreSQL Flexible server based on AZURE_POSTGRESQL_CONNECTIONSTRING...")
     env_connection_string = os.getenv("AZURE_POSTGRESQL_CONNECTIONSTRING")
-
-    # Parse the connection string
-    details = dict(item.split('=') for item in env_connection_string.split())
-
-    # Properly format the URL for SQLAlchemy
-    sql_url = (
-        f"postgresql://{quote_plus(details['user'])}:{quote_plus(details['password'])}"
-        f"@{details['host']}:{details['port']}/{details['dbname']}?sslmode={details['sslmode']}"
-    )
+    if env_connection_string is None:
+        print("Missing environment variable AZURE_POSTGRESQL_CONNECTIONSTRING")
+    else:
+        # Parse the connection string
+        details = dict(item.split('=') for item in env_connection_string.split())
+
+        # Properly format the URL for SQLAlchemy
+        sql_url = (
+            f"postgresql://{quote_plus(details['user'])}:{quote_plus(details['password'])}"
+            f"@{details['host']}:{details['port']}/{details['dbname']}?sslmode={details['sslmode']}"
+        )
 
 else:
-    POSTGRES_USERNAME = os.environ.get("POSTGRES_PASSWORD")
-    POSTGRES_PASSWORD = os.environ.get("POSTGRES_PASSWORD")
-    POSTGRES_HOST = os.environ.get("POSTGRES_HOST")
-    POSTGRES_DATABASE = os.environ.get("POSTGRES_DATABASE")
-    POSTGRES_PORT = os.environ.get("POSTGRES_PORT", 5432)
+    print("Connecting to local PostgreSQL server based on .env file...")
+    load_dotenv()
+    POSTGRES_USERNAME = os.environ.get("DBUSER")
+    POSTGRES_PASSWORD = os.environ.get("DBPASS")
+    POSTGRES_HOST = os.environ.get("DBHOST")
+    POSTGRES_DATABASE = os.environ.get("DBNAME")
+    POSTGRES_PORT = os.environ.get("DBPORT", 5432)
 
     sql_url = f"postgresql://{POSTGRES_USERNAME}:{POSTGRES_PASSWORD}@{POSTGRES_HOST}:{POSTGRES_PORT}/{POSTGRES_DATABASE}"
 

src/fastapi_app/models.py

@@ -1,4 +1,3 @@
-from dotenv import load_dotenv
 from sqlmodel import SQLModel
 
 from fastapi_app.models import Restaurant, Review, create_db_and_tables, engine
@@ -12,5 +11,4 @@ def drop_all():
 
 
 if __name__ == "__main__":
-    load_dotenv()
     create_db_and_tables()