Apply suggestions from code review

lionello · web-flow · commit 789cdcff5245 · 2025-07-25T16:58:56.000-07:00
diff --git a/.github/workflows/deploy.yaml b/.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/defang-github-action@v1.1.0
diff --git a/README.md b/README.md
@@ -0,0 +1,55 @@
+# Flask-Railpack
+
+[![1-click-deploy](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Buttons/SVG/deploy-with-defang.svg)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-flask-template%26template_owner%3DDefangSamples)
+
+This is a basic Flask to-do app that can be deployed with Defang. Note that alongside your `.py` file, include a `requirements.txt` so that the [Railpack](https://railpack.com/) can install the necessary packages with pip.
+
+This project is intended to provide a basic understanding of how to get started with Flask on Defang. The items are stored in memory and are lost when the server is restarted. **It is not intended for production use**. If you need something production ready, you should use a managed database like Postgres or MySQL.
+
+## Prerequisites
+
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+
+## Configuration
+
+For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
+
+If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
+
+```bash
+defang config set API_KEY
+```
+
+## 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: Flask
+
+Short Description: A basic Flask to-do app.
+
+Tags: Flask, Python, Railpack
+
+Languages: python
diff --git a/compose.yaml b/compose.yaml
@@ -0,0 +1,16 @@
+services:
+  flask:
+    restart: unless-stopped
+    build:
+      context: ./flask
+    deploy:
+      resources:
+        reservations:
+          cpus: "1.0"
+          memory: 512M
+    ports:
+      - mode: ingress
+        target: 5000
+        published: 5000
+    healthcheck:
+      test: ["CMD", "python3", "-c", "import sys, urllib.request; urllib.request.urlopen(sys.argv[1]).read()", "http://localhost:5000/"]
diff --git a/flask/app.py b/flask/app.py
@@ -0,0 +1,49 @@
+from flask import Flask, jsonify, request, render_template_string
+
+app = Flask(__name__)
+
+# A simple in-memory structure to store tasks
+tasks = []
+
+@app.route('/', methods=['GET'])
+def home():
+    # Display existing tasks and a form to add a new task
+    html = '''
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Todo List</title>
+</head>
+<body>
+    <h1>Todo List</h1>
+    <form action="/add" method="POST">
+        <input type="text" name="task" placeholder="Enter a new task">
+        <input type="submit" value="Add Task">
+    </form>
+    <ul>
+        {% for task in tasks %}
+        <li>{{ task }} <a href="/delete/{{ loop.index0 }}">x</a></li>
+        {% endfor %}
+    </ul>
+</body>
+</html>
+'''
+    return render_template_string(html, tasks=tasks)
+
+@app.route('/add', methods=['POST'])
+def add_task():
+    # Add a new task from the form data
+    task = request.form.get('task')
+    if task:
+        tasks.append(task)
+    return home()
+
+@app.route('/delete/<int:index>', methods=['GET'])
+def delete_task(index):
+    # Delete a task based on its index
+    if index < len(tasks):
+        tasks.pop(index)
+    return home()
+
+if __name__ == '__main__':
+    app.run(debug=True, host='0.0.0.0')
diff --git a/flask/requirements.txt b/flask/requirements.txt
@@ -0,0 +1,3 @@
+Flask==2.2.5
+Werkzeug==2.2.2
+MarkupSafe==2.1.1

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Flask==2.2.5`
	`2`	`+Werkzeug==2.2.2`
	`3`	`+MarkupSafe==2.1.1`