Merge pull request #336 from DefangLabs/linda-nounly-go

Nounly Sample

Author: commit111

.github/workflows/deploy.yaml

@@ -0,0 +1,21 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    environment: playground
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Deploy
+      uses: DefangLabs/[email protected]

README.md

@@ -0,0 +1,67 @@
+# FastAPI & PostgreSQL
+
+[![1-click-deploy](https://defang.io/deploy-with-defang.svg)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-fastapi-postgres-template%26template_owner%3DDefangSamples)
+
+This sample project demonstrates how to deploy FastAPI with PostgreSQL with Defang.
+
+## Prerequisites
+
+1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
+2. (optional) If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account</a>.
+
+## Development
+
+To run the development container(s) locally, do:
+
+```bash
+docker compose -f compose.dev.yaml up --build
+```
+
+Or to run the production container(s) locally, do:
+
+```bash
+POSTGRES_PASSWORD=postgres docker compose up --build
+```
+
+## Configuration
+
+For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration): 
+
+> Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
+
+### `POSTGRES_PASSWORD` 
+``` bash
+defang config set POSTGRES_PASSWORD
+```
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the Defang Playground by opening up your terminal and typing:
+```bash
+defang compose up
+```
+
+### BYOC (AWS)
+
+If you want to deploy to your own cloud account, you can use Defang BYOC:
+
+1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+2. Run in a terminal that has access to your AWS environment variables:
+    ```bash
+    defang --provider=aws compose up
+    ```
+
+---
+
+Title: FastAPI & PostgreSQL
+
+Short Description: A sample project with FastAPI and PostgreSQL.
+
+Tags: FastAPI, PostgreSQL, Python, SQL
+
+Languages: python

compose.dev.yaml

@@ -0,0 +1,22 @@
+services:
+  fastapi:
+    extends:
+      file: compose.yaml
+      service: fastapi
+    environment:
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
+    volumes:
+      - ./fastapi:/app
+    depends_on:
+      - db
+    command: fastapi dev main.py --host 0.0.0.0
+
+  db:
+    extends:
+      file: compose.yaml
+      service: db
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_DB=postgres
+

compose.yaml

@@ -0,0 +1,29 @@
+services:
+  fastapi:
+    restart: unless-stopped
+    build:
+      context: ./fastapi
+      dockerfile: Dockerfile
+    ports:
+      - mode: ingress
+        target: 8000
+        published: 8000
+    environment:
+      - DB_URL=postgres://postgres:${POSTGRES_PASSWORD}@db:5432/postgres
+    depends_on:
+      - db
+    #deploy:
+    #  resources:
+    #    reservations:
+    #      memory: 256M
+
+  db:
+    image: postgres:15
+    restart: unless-stopped
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD
+      - POSTGRES_DB=postgres
+    ports:
+      - mode: host
+        target: 5432

fastapi/.dockerignore

@@ -0,0 +1,5 @@
+__pycache__/
+env/
+venv/
+ENV/
+build/

fastapi/.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+env/
+venv/
+ENV/
+build/

fastapi/Dockerfile

@@ -0,0 +1,27 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11-slim
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Install required C++11 libraries and ca-certificates
+RUN apt-get update -qq \
+      && apt-get install -y \
+      build-essential \
+      python3-dev \
+      ca-certificates \
+      && apt-get clean \
+      && rm -rf /var/lib/apt/lists/*
+
+# Install any needed packages specified in requirements.txt
+COPY requirements.txt /app/
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the current directory contents into the container at /app
+COPY . /app
+
+# Make port 5000 available to the world outside this container
+EXPOSE 8000
+
+# Run main when the container launches
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

fastapi/main.py

@@ -0,0 +1,59 @@
+import os
+from fastapi import FastAPI, Request, Form
+from fastapi.templating import Jinja2Templates
+from fastapi.responses import RedirectResponse
+import asyncpg
+from contextlib import asynccontextmanager
+from pydantic import BaseModel
+from databases import Database
+from dotenv import load_dotenv
+
+load_dotenv()
+
+database_url = os.getenv("DB_URL")
+print(f"Connecting to database at: {database_url}")
+database = Database(database_url)
+
+
+class TodoItem(BaseModel):
+    id: int
+    task: str
+    completed: bool = False
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await database.connect()
+    conn = await asyncpg.connect(database_url)
+    await conn.execute('''
+            CREATE TABLE IF NOT EXISTS todos (
+            id SERIAL PRIMARY KEY,
+            task VARCHAR(255) NOT NULL,
+            completed BOOLEAN DEFAULT FALSE
+    );
+    ''')
+    await conn.close()
+    yield
+    await database.disconnect()
+
+app = FastAPI(lifespan=lifespan)
+templates = Jinja2Templates(directory="templates")
+
+
+@app.get("/")
+async def get_todos(request: Request):
+    query = "SELECT * FROM todos"
+    todos = await database.fetch_all(query)
+    return templates.TemplateResponse("index.html", {"request": request, "todos": todos})
+
+@app.post("/add")
+async def create_todo(task: str = Form(...)):
+    query = "INSERT INTO todos(task, completed) VALUES (:task, :completed)"
+    values = {"task": task, "completed": False}
+    await database.execute(query, values)
+    return RedirectResponse(url="/", status_code=303)
+
+@app.post("/delete/{todo_id}")
+async def delete_todo(todo_id: int):
+    query = "DELETE FROM todos WHERE id = :todo_id"
+    await database.execute(query, {"todo_id": todo_id})
+    return RedirectResponse(url="/", status_code=303)

fastapi/requirements.txt

@@ -0,0 +1,8 @@
+uwsgi
+fastapi[standard]
+uvicorn
+asyncpg
+databases
+python-dotenv
+jinja2
+python-multipart

fastapi/templates/index.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>FastAPI &amp; Defang To-Do List</title>
+</head>
+<body>
+    <h1>FastAPI &amp; Defang To-Do List</h1>
+    <form action="/add" method="post">
+        <input type="text" name="task" placeholder="New task" required>
+        <button type="submit">Add Task</button>
+    </form>
+    <ul>
+        {% for todo in todos %}
+        <li>
+            {{ todo.task }}
+            <form action="/delete/{{ todo.id }}" method="post" style="display:inline;">
+                <button type="submit">Delete</button>
+            </form>
+        </li>
+        {% endfor %}
+    </ul>
+</body>
+</html>