Merge branch 'main' into 18-nocodb-sample

Author: raphaeltm

.github/workflows/check-sample.yml

@@ -26,10 +26,12 @@ jobs:
           echo "@@ MODIFIED @@"
           cat modified.txt
 
-      - name: Validate Compose Files with Defang CLI
-        run: |
-          . <(curl -Ls https://s.defang.io/install)
-          cat modified.txt | xargs -n1 defang compose config -C > /dev/null
+      # TODO: Uncomment the following lines to validate the Compose files
+      #       once we figure out how to prevent it from erroring on warnings.
+      # - name: Validate Compose Files with Defang CLI
+      #   run: |
+      #     . <(curl -Ls https://s.defang.io/install)
+      #     cat modified.txt | xargs -n1 defang compose config -C > /dev/null
 
       - name: Add checklist to PR description
         uses: actions/github-script@v5

README.md

@@ -1,5 +1,9 @@
 # Defang Samples
 
-Samples to show you how to create and deploy apps with Defang.
+Samples to show you how to develop, deploy, and debug cloud applications with Defang.
 
 Browse through the [./samples](./samples) directory, or search and browse in the [docs](https://docs.defang.io/docs/samples).
+
+## Adding Samples
+
+To start working on a new sample, run `. ./scripts/new-sample.sh` from the root of the repository. This will create a new sample directory, with some basic scaffolding to get you started. Look for `#REMOVE_ME_AFTER_EDITING` in your new project to look for things that you should probably be changing/checking per sample. Feel free to remove files, like `compose.dev.yaml` if they aren't necessary for your sample.

samples/angular-express/README.md

@@ -37,6 +37,6 @@ 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, nodejs, Socket.IO
+Tags: Angular, Node.js, Socket.IO, TypeScript, JavaScript
 
-Languages: typescript, javascript
+Languages: nodejs

samples/bullmq-bullboard-redis/README.md

@@ -8,7 +8,6 @@ To add a job to the queue, you can go to the `/add` route of the `api` service.
 
 The `worker` service is the queue processor that will process the jobs added to the queue. You can see in the `compose.yaml` file that the `worker` service is set to scale to 2 instances. This means that there will be 2 workers processing jobs from the queue. You can set this to your desired number of workers, but we wanted to show how you can increase the number of workers to handle more jobs.
 
-
 ## Prerequisites
 
 1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
@@ -21,7 +20,6 @@ The `worker` service is the queue processor that will process the jobs added to
 3. Type `defang compose up` in the CLI.
 4. Your app will be running within a few minutes.
 
-
 ## Local Development
 
 1. Run `docker compose -f compose.dev.yaml up`
@@ -32,6 +30,6 @@ Title: BullMQ & BullBoard & Redis
 
 Short Description: A sample project with BullMQ, BullBoard, and Redis.
 
-Tags: BullMQ, BullBoard, Redis, Express, Node.js, Message Queue
+Tags: BullMQ, BullBoard, Redis, Express, Node.js, Message Queue, JavaScript
 
-Languages: nodejs, javascript
+Languages: nodejs

samples/bullmq-bullboard-redis/compose.yaml

@@ -14,6 +14,10 @@ services:
       - QUEUE
     depends_on:
       - redis
+    #deploy:
+    #  resources:
+    #    reservations:
+    #      memory: 256M
 
   api:
     restart: unless-stopped
@@ -29,6 +33,10 @@ services:
       - QUEUE
     depends_on:
       - redis
+    #deploy:
+    #  resources:
+    #    reservations:
+    #      memory: 256M
 
   worker:
     restart: unless-stopped
@@ -44,6 +52,10 @@ services:
       test: ["CMD", "wget", "-q", "--spider", "127.0.0.1:3000"]
     depends_on:
       - redis
+    #deploy:
+    #  resources:
+    #    reservations:
+    #      memory: 256M
 
   redisx:
     image: redis:6.2

samples/csharp-dotnet/README.md

@@ -0,0 +1,41 @@
+# ASP.NET Core & JavaScript Task Manager
+
+This project is a simple task manager application using ASP.NET Core for the backend and JavaScript for client-side component rendering. We show case how to deploy it to both defang and docker for both prod and dev environments.
+
+## NOTE
+
+This sample showcases how you could deploy a full-stack application with ASP.NET Core and JavaScript using Defang. The Docker setup ensures the app can be easily built and tested during development.
+
+## Essential Setup Files
+
+1. Download [Defang CLI](https://github.com/defang-io/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) authenticated with your AWS account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+
+## Prerequisites
+
+1. Download [Defang CLI](https://github.com/defang-io/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) make sure you have properly authenticated your AWS account
+3. [ASP.NET Core](https://dotnet.microsoft.com/download/dotnet-core)
+
+## A Step-by-Step Guide for deployment
+
+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!
+
+## Development
+
+For development, we use two local containers, one for the frontend service and one for the backend service in ASP.NET Core. It also uses Caddy as a web server for serving static files. To run the sample locally after cloning the repository, you can run on Docker by doing:
+
+`docker compose -f compose.dev.yaml up`
+
+---
+
+Title: ASP.NET Core & JavaScript Task Manager
+
+Short Description: A task manager using ASP.NET Core for the backend and JavaScript for the frontend, containerized with Docker.
+
+Tags: ASP.NET Core, JavaScript, C#
+
+Languages: C#, JavaScript

samples/csharp-dotnet/app/.dockerignore

@@ -0,0 +1,4 @@
+bin/
+obj/
+.vs/
+.vscode/

samples/csharp-dotnet/app/.gitignore

@@ -0,0 +1,2 @@
+bin/
+obj/

samples/csharp-dotnet/app/Dockerfile

@@ -0,0 +1,22 @@
+# Use the official .NET SDK image for building the application
+FROM mcr.microsoft.com/dotnet/sdk:7.0 AS build-env
+WORKDIR /app
+
+# Copy csproj and restore as distinct layers
+COPY *.csproj ./
+RUN dotnet restore
+
+# Copy everything else and build
+COPY . ./
+RUN dotnet publish -c Release -o out
+
+# Use the official .NET runtime image for running the application
+FROM mcr.microsoft.com/dotnet/aspnet:7.0
+WORKDIR /app
+COPY --from=build-env /app/out .
+
+# Expose port 80
+EXPOSE 80
+
+# Start the application
+ENTRYPOINT ["dotnet", "csharp-dotnet.dll"]

samples/csharp-dotnet/app/Pages/Index.cshtml

@@ -0,0 +1,45 @@
+@page
+@model csharp_dotnet.Pages.IndexModel
+@{
+    ViewData["Title"] = "Task Manager";
+}
+
+<div class="text-center">
+    <h1 class="display-4">Task Manager</h1>
+    <input type="text" id="taskInput" placeholder="Add a new task" />
+    <button onclick="addTask()">Add Task</button>
+    <ul id="taskList"></ul>
+</div>
+
+<script>
+    let tasks = [];
+
+    function addTask() {
+        const taskInput = document.getElementById('taskInput');
+        const task = taskInput.value.trim();
+        if (task) {
+            tasks.push(task);
+            taskInput.value = '';
+            renderTasks();
+        }
+    }
+
+    function removeTask(index) {
+        tasks.splice(index, 1);
+        renderTasks();
+    }
+
+    function renderTasks() {
+        const taskList = document.getElementById('taskList');
+        taskList.innerHTML = '';
+        tasks.forEach((task, index) => {
+            const li = document.createElement('li');
+            li.textContent = task + ' ';
+            const removeButton = document.createElement('button');
+            removeButton.textContent = 'Remove';
+            removeButton.onclick = () => removeTask(index);
+            li.appendChild(removeButton);
+            taskList.appendChild(li);
+        });
+    }
+</script>