misc readme updates

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,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]

.gitignore

@@ -0,0 +1,66 @@
+# Node.js dependencies
+node_modules/
+
+# Logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Temporary directories
+tmp/
+temp/
+dist/
+build/
+
+# Compiled JavaScript
+*.d.ts
+*.js.map
+
+# Compiled CSS
+*.css
+*.css.map
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Environment variables
+.env
+
+# Coverage reports
+coverage/
+
+# Angular specific files
+.angular/
+.angular-cache/
+.sass-cache/
+
+# Generated files
+*.class
+*.war
+*.ear
+
+# NPM lock file
+package-lock.json
+
+# Angular build outputs
+out-tsc/
+aot/
+app.out/
+vendor/
+
+# Miscellaneous
+*.bak
+*.orig
+.angular
+
+.gitkeep
+.editorconfig
+.DS_Store

README.md

@@ -0,0 +1,64 @@
+# Angular & Node.js
+
+[![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-angular-express-template%26template_owner%3DDefangSamples)
+
+This sample demonstrates how to deploy a full-stack Angular and Node.js application with Defang. It uses Socket.IO for real-time communication. The Docker setup ensures the app can be easily built and deployed.
+
+## 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/)
+4. Install [Node.js](https://nodejs.org/en/download/package-manager/)
+5. Install [Angular CLI](https://angular.io/cli)
+
+## Development
+For development, we use two local containers, one for the frontend Angular service and one for the backend service in Express. It also uses Caddy as a web server for serving static files. 
+
+To run the application locally, you can use the following command:
+
+```bash
+docker compose -f compose.dev.yaml up --build
+```
+
+## 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: Angular & Node.js
+
+Short Description: A full-stack application using Angular for the frontend and Node.js with Socket.IO for the backend, containerized with Docker.
+
+Tags: Angular, Node.js, Socket.IO, TypeScript, JavaScript
+
+Languages: nodejs

backend/.dockerignore

@@ -0,0 +1,33 @@
+# Dependency directories
+node_modules
+npm-debug.log
+
+# Logs
+logs
+*.log
+
+# Directory for output files
+dist
+tmp
+
+# Environmental files
+.env
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional editor config files
+.editorconfig
+
+# IDEs and editors
+.idea
+.vscode
+*.sublime*
+
+# OS files
+.DS_Store
+Thumbs.db
+desktop.ini

backend/Dockerfile

@@ -0,0 +1,20 @@
+# Use the slim version of Node.js v20 on Debian Bookworm as the base image
+FROM node:20-bookworm-slim
+
+# Create and change to the app directory
+WORKDIR /app
+
+# Copy application dependency manifests to the container image
+COPY package*.json ./
+
+# Install dependencies
+RUN npm install
+
+# Copy the local code to the container image
+COPY . .
+
+# Expose the port the app runs on
+EXPOSE 3000
+
+# Define the command to run your application
+CMD ["npm", "start"]