Merge pull request #230 from DefangLabs/linda-typo-3

Uppercase HTTP and more fixes in readme

Author: commit111

.devcontainer/Dockerfile

@@ -0,0 +1,2 @@
+
+FROM mcr.microsoft.com/devcontainers/typescript-node:22-bookworm

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "features": {
+    "ghcr.io/defanglabs/devcontainer-feature/defang-cli:1.0.4": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/aws-cli:1": {}
+  }
+}

.github/workflows/deploy.yaml

@@ -0,0 +1,20 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    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,31 @@
+# Node.js & Express
+
+[![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-nodejs-express-template%26template_owner%3DDefangSamples)
+
+This Node.js application, built with Express.js, is designed to inspect and display detailed information about incoming HTTP requests. It supports all HTTP methods and provides insights into the request path, method, headers, query parameters, and body. Note alongside your project, you should also include a package.json file that includes the relevant metadata such as package dependencies, scripts, project verrsions so that the Dockerfile can install necessary dependencies.
+
+## Essential Setup Files
+
+1. A [Dockerfile](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/).
+2. A [compose file](https://docs.defang.io/docs/concepts/compose) to define and run multi-container Docker applications (this is how Defang identifies services to be deployed).
+
+## Prerequisite
+
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc), make sure you have properly [authenticated your AWS account (optional)](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
+
+## A Step-by-Step Guide
+
+1. Open the terminal and type `defang login`
+2. Type `defang compose up` in the CLI
+3. Your app should be up and running with Defang in minutes!
+
+---
+
+Title: Node.js & Express
+
+Short Description: A Node.js application that inspects and displays detailed information about incoming HTTP requests.
+
+Tags: Node.js, Express, HTTP, Request, Inspector, JavaScript
+
+Languages: nodejs

app/Dockerfile

@@ -0,0 +1,25 @@
+# Use the slim version of Node.js on Debian Bookworm as the base image
+FROM node:20-bookworm-slim
+
+RUN apt-get update -qq \
+      && apt-get install -y curl \
+      && apt-get clean \
+      && rm -rf /var/lib/apt/lists/*
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Copy package.json and package-lock.json into the container at /app
+COPY package*.json ./
+
+# Install any needed packages specified in package.json
+RUN npm ci
+
+# Copy the current directory contents into the container at /app
+COPY . .
+
+# Make port 3000 available to the world outside this container
+EXPOSE 3000
+
+# Run the app when the container launches
+ENTRYPOINT ["node", "main.js"]

app/main.js

@@ -0,0 +1,20 @@
+const express = require('express');
+const app = express();
+const bodyParser = require('body-parser');
+
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: true }));
+
+app.all("/", (req, res) => {
+    res.send({
+        "path" : req.path,
+        "method" : req.method,
+        "headers" : req.headers,
+        "args" : req.query,
+        "body" : req.body
+    });
+});
+
+app.listen(3000, () => {
+    console.log('Server started on port 3000');
+});