Update readme

KevyVo · KevyVo · commit 8b0cf0157962 · 2025-07-25T15:57:47.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,54 @@
+# Golang-Http-Form-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-golang-http-form-template%26template_owner%3DDefangSamples)
+
+This Go application demonstrates a simple form submission using the standard net/http library. Users can input their first name into a form, and upon submission, they will be greeted personally by the application.
+
+## 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
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+
+## 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: Go HTTP Form
+
+Short Description: A simple Go application that demonstrates form submission using the net/http library.
+
+Tags: Go, HTTP, Railpack
+
+Languages: golang
diff --git a/app/go.mod b/app/go.mod
@@ -0,0 +1,3 @@
+module defang.io/sample
+
+go 1.20
diff --git a/app/go.sum b/app/go.sum
diff --git a/app/main.go b/app/main.go
@@ -0,0 +1,100 @@
+package main
+
+import (
+	"context"
+	"html/template"
+	"log"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+)
+
+var indexTmpl = template.Must(template.New("index").Parse(`
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Simple form post</title>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            margin: 20px;
+        }
+
+        label {
+            font-weight: bold;
+        }
+
+        input[type="text"] {
+            padding: 5px;
+            margin-bottom: 10px;
+            width: 200px;
+        }
+
+        input[type="submit"] {
+            padding: 10px 20px;
+            background-color: #4CAF50;
+            color: white;
+            border: none;
+            cursor: pointer;
+        }
+    </style>
+</head>
+<body>
+    <h1>Simple form post</h1>
+    <form action="/submit" method="post">
+        <label for="first_name">First name:</label><br>
+        <input type="text" id="first_name" name="first_name"><br>
+        <input type="submit" value="Submit">
+    </form>
+</body>
+</html>
+`))
+
+var submitTmpl = template.Must(template.New("submit").Parse(`
+    <html>
+        <head>
+            <title>Simple form post</title>
+        </head>
+        <body>
+            <h1>Hello {{.FirstName}}!</h1>
+        </body>
+    </html>
+`))
+
+func main() {
+	http.HandleFunc("/", indexHandler)
+	http.HandleFunc("/submit", submitHandler)
+
+	// Register signal handler for graceful shutdown
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)
+	defer signal.Stop(sigs)
+
+	server := &http.Server{Addr: ":8080"}
+	go func() {
+		if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
+			log.Fatalf("HTTP server Serve: %v\n", err)
+		}
+	}()
+
+	sig := <-sigs
+	log.Printf("Received signal %v, shutting down...\n", sig)
+	log.Fatal(server.Shutdown(context.Background()))
+}
+
+func indexHandler(w http.ResponseWriter, r *http.Request) {
+	w.Header().Set("Content-Type", "text/html")
+	indexTmpl.Execute(w, nil)
+}
+
+func submitHandler(w http.ResponseWriter, r *http.Request) {
+	if r.Method != http.MethodPost {
+		http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
+		return
+	}
+
+	w.Header().Set("Content-Type", "text/html")
+	firstName := r.FormValue("first_name")
+	submitTmpl.Execute(w, struct{ FirstName string }{firstName})
+}
diff --git a/compose.yaml b/compose.yaml
@@ -0,0 +1,14 @@
+services:
+  app:
+    restart: unless-stopped
+    build:
+      context: ./app
+    ports:
+      - mode: ingress
+        target: 8080
+    deploy:
+      resources:
+        reservations:
+          memory: 50M
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8080/"]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module defang.io/sample`
	`2`	`+`
	`3`	`+go 1.20`