Merge branch 'main' into linda-vue-baseimage

commit111 · web-flow · commit af17f029cf9d · 2024-10-10T15:31:23.000-07:00
diff --git a/samples/django/README.md b/samples/django/README.md
@@ -35,7 +35,7 @@ The Dockerfile and compose files are already set up for you and are ready to be
 
 Title: Django
 
-Short Description: A simple Django app that uses SQLite as the database
+Short Description: A simple Django app that uses SQLite as the database.
 
 Tags: Django, SQLite, Python
 
diff --git a/samples/fastapi-postgres/README.md b/samples/fastapi-postgres/README.md
@@ -23,7 +23,7 @@ This sample project demonstrates how to deploy FastAPI with PostgreSQL with Defa
 
 Title: FastAPI & PostgreSQL
 
-Short Description: A sample project with FastAPI and PostgreSQL
+Short Description: A sample project with FastAPI and PostgreSQL.
 
 Tags: FastAPI, PostgreSQL, Python, SQL
 
diff --git a/samples/fastapi/README.md b/samples/fastapi/README.md
@@ -29,7 +29,7 @@ That will start your FastAPI app on `http://localhost:8000` with hot reloading e
 
 Title: FastAPI
 
-Short Description: A sample project demonstrating how to deploy FastAPI with Defang
+Short Description: A sample project demonstrating how to deploy FastAPI with Defang.
 
 Tags: FastAPI, OpenAPI, Python
 
diff --git a/samples/golang-http-form/README.md b/samples/golang-http-form/README.md
@@ -27,10 +27,10 @@ This Go application demonstrates a simple form submission using the standard net
 
 ---
 
-Title: Go http Form
+Title: Go HTTP Form
 
 Short Description: A simple Go application that demonstrates form submission using the net/http library.
 
-Tags: Go, http
+Tags: Go, HTTP
 
 Languages: golang
diff --git a/samples/golang-http/README.md b/samples/golang-http/README.md
@@ -6,10 +6,10 @@ A very simple example of a Go service that listens on a port and returns informa
 
 ---
 
-Title: Go http Server
+Title: Go HTTP Server
 
 Short Description: A simple Go application that echoes back the request.
 
-Tags: Go, http
+Tags: Go, HTTP
 
 Languages: golang
diff --git a/samples/golang-mongodb-atlas/README.md b/samples/golang-mongodb-atlas/README.md
@@ -37,8 +37,8 @@ Environment: Designed to run in containerized environments using Docker, which e
 
 Title: Go & MongoDB Atlas
 
-Short Description: A simple Go application that manages tasks with MongoDB Atlas
+Short Description: A simple Go application that manages tasks with MongoDB Atlas.
 
-Tags: Go, MongoDB, Atlas, Task manager
+Tags: Go, MongoDB, Atlas, Task Manager
 
 Languages: golang
diff --git a/samples/golang-rest-api/README.md b/samples/golang-rest-api/README.md
@@ -10,6 +10,6 @@ Title: Go & REST API
 
 Short Description: A simple Go application that fetches fiscal data from an API.
 
-Tags: Go, http, Fiscal data, REST API
+Tags: Go, http, Fiscal Data, REST API
 
 Languages: golang
diff --git a/samples/html-css-js/README.md b/samples/html-css-js/README.md
@@ -1,6 +1,6 @@
 # HTML & CSS & JavaScript
 
-[1-click deploy](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-html-css-js-template%26template_owner%3DDefangSamples)
+[![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-html-css-javascript-template%26template_owner%3DDefangSamples)
 
 This sample shows how to get a static HTML + CSS + JavaScript website up and running with Defang.
 
@@ -15,15 +15,31 @@ This sample shows how to get a static HTML + CSS + JavaScript website up and run
 To run the application locally, you can use the following command:
 
 ```bash
-docker compose up
+docker compose up --build
 ```
 
-## Deploying
 
-1. Open the terminal and type `defang login`
-2. Type `defang compose up` in the CLI.
-3. Your app will be running within a few minutes.
+## 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: HTML & CSS & JavaScript
@@ -32,4 +48,4 @@ Short Description: A simple HTML + CSS + JavaScript website running on Defang.
 
 Tags: HTML, CSS, JavaScript, Frontend
 
-Languages: HTML, CSS, JavaScript
+Languages: nodejs
diff --git a/samples/huginn/README.md b/samples/huginn/README.md
@@ -27,7 +27,7 @@ To start the local environment, run `docker compose -f ./compose.yaml -f ./compo
 
 Title: Huginn
 
-Short Description: A system for building agents that perform automated tasks for you online
+Short Description: A system for building agents that perform automated tasks for you online.
 
 Tags: Huginn, Agents, Automation
 
diff --git a/samples/imgproxy/README.md b/samples/imgproxy/README.md
@@ -2,7 +2,7 @@
 
 [![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-imgproxy-template%26template_owner%3DDefangSamples)
 
-ImgProxy is a fast and secure standalone server for resizing and converting remote images. It's can be deployed using their official Docker image, as documented [here](https://docs.imgproxy.net/installation#docker).
+ImgProxy is a fast and secure standalone server for resizing and converting remote images. It can be deployed using the official Docker image, as documented [here](https://docs.imgproxy.net/installation#docker).
 
 ## Prerequisites
 
diff --git a/samples/javalin/README.md b/samples/javalin/README.md
@@ -28,7 +28,7 @@ docker compose up --build
 
 Title: Javalin
 
-Short Description: A short hello world application demonstrating how to deploy Javalin onto defang.
+Short Description: A short hello world application demonstrating how to deploy Javalin onto Defang.
 
 Tags: Javalin, Java, Maven
 
diff --git a/samples/nocodb/README.md b/samples/nocodb/README.md
@@ -57,7 +57,7 @@ For development, we use a local postgres container and a volume mount for file u
 
 Title: NocoDB
 
-Short Description: An open source alternative to AirTable
+Short Description: An open source alternative to AirTable.
 
 Tags: NocoDB
 
diff --git a/samples/nodejs-express/README.md b/samples/nodejs-express/README.md
@@ -24,8 +24,8 @@ This Node.js application, built with Express.js, is designed to inspect and disp
 
 Title: Node.js & Express
 
-Short Description: A Node.js application that inspects and displays detailed information about incoming http requests.
+Short Description: A Node.js application that inspects and displays detailed information about incoming HTTP requests.
 
-Tags: Node.js, Express, http, Request, Inspector, JavaScript
+Tags: Node.js, Express, HTTP, Request, Inspector, JavaScript
 
 Languages: nodejs
diff --git a/samples/nodejs-form/README.md b/samples/nodejs-form/README.md
@@ -26,6 +26,6 @@ Title: Node.js Express Form
 
 Short Description: A Node.js application that handles form submissions using the Express framework.
 
-Tags: Node.js, Express, http, JavaScript
+Tags: Node.js, Express, HTTP, JavaScript
 
 Languages: nodejs
diff --git a/samples/nodejs-http/README.md b/samples/nodejs-http/README.md
@@ -20,8 +20,8 @@ defang compose up
 
 Title: Node.js HTTP Server
 
-Short Description: A simple Node.js application that creates an http server.
+Short Description: A simple Node.js application that creates an HTTP server.
 
-Tags: Node.js, http, Server
+Tags: Node.js, HTTP, Server
 
 Languages: nodejs
diff --git a/samples/pulumi-remix-postgres/README.md b/samples/pulumi-remix-postgres/README.md
@@ -45,6 +45,6 @@ Title: Pulumi & Remix & PostgreSQL
 
 Short Description: A full-stack example using Remix, Prisma, and Aiven.
 
-Tags: Full stack, Remix, Prisma, Aiven, PostgreSQL, Pulumi, Node.js, TypeScript, SQL
+Tags: Full-stack, Remix, Prisma, Aiven, PostgreSQL, Pulumi, Node.js, TypeScript, SQL
 
 Languages: nodejs
diff --git a/samples/pulumi/README.md b/samples/pulumi/README.md
@@ -38,8 +38,8 @@ pulumi up
 
 Title: Pulumi
 
-Short Description: A basic Pulumi example
+Short Description: A basic Pulumi example.
 
-Tags: pulumi, Node.js, http, server, TypeScript
+Tags: Pulumi, Node.js, HTTP, Server, TypeScript
 
 Languages: nodejs
diff --git a/samples/python-form/README.md b/samples/python-form/README.md
@@ -24,8 +24,8 @@ This Flask application provides a basic example of handling form submissions. It
 
 Title: Python & Form
 
-Short Description: A short python example for form submission in flask.
+Short Description: A short Python example for form submission in Flask.
 
-Tags: Python, Flask, form
+Tags: Python, Flask, Form
 
 Languages: python
diff --git a/samples/python-minimal/README.md b/samples/python-minimal/README.md
@@ -29,8 +29,8 @@ This Flask application is designed to inspect and return detailed information ab
 
 Title: Flask
 
-Short Description: A Flask application that inspects and returns detailed information about http requests.
+Short Description: A Flask application that inspects and returns detailed information about HTTP requests.
 
-Tags: Flask, http, Python
+Tags: Flask, HTTP, Python
 
 Languages: python
diff --git a/samples/vllm/README.md b/samples/vllm/README.md
@@ -45,7 +45,7 @@ By following these steps, you should be able to deploy Mistral along with a cust
 
 Title: Mistral & vLLM
 
-Short Description: Deploy Mistral with a custom UI using vLLM
+Short Description: Deploy Mistral with a custom UI using vLLM.
 
 Tags: Mistral, vLLM, AI, Nextjs, GPU, Node.js, TypeScript, JavaScript
 
diff --git a/samples/vuejs/README.md b/samples/vuejs/README.md
@@ -18,12 +18,33 @@ To run the application locally, you can use the following command (make sure you
 npm run dev
 ```
 
-## Deploying
+To run it using a Docker container, you can use the following command:
 
-1. Open the terminal and type `defang login`
-2. Type `defang compose up` in the CLI.
-3. Your app will be running within a few minutes.
+```bash
+docker compose up --build
+```
+
+## 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: Vue.js
@@ -32,5 +53,5 @@ Short Description: A minimal Vue.js app running on Defang.
 
 Tags: Vue.js, Vite, Node.js, Frontend, JavaScript
 
-Languages: javascript
+Languages: nodejs
 
diff --git a/samples/vuejs/compose.yaml b/samples/vuejs/compose.yaml
@@ -13,4 +13,4 @@ services:
         reservations:
           memory: 512M
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:5173/"]
+      test: ["CMD", "curl", "-f", "http://localhost:5173/"]
diff --git a/starter-sample/README.md b/starter-sample/README.md
@@ -24,7 +24,7 @@ docker compose up --build
 
 For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration). Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
 
-### `API_KEY` #REMOVE_ME_AFTER_EDITING
+### `API_KEY` #REMOVE_ME_AFTER_EDITING 
 An explanation of what the env var (`API_KEY`) is, etc.
 
 ## Deployment
@@ -34,14 +34,20 @@ An explanation of what the env var (`API_KEY`) is, etc.
 
 ### Defang Playground
 
-Deploy your application to the defang playground by opening up your terminal and typing `defang compose up`.
+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 `defang --provider=aws up` in a terminal that has access to your AWS environment variables.
+2. Run in a terminal that has access to your AWS environment variables:
+    ```bash
+    defang --provider=aws compose up
+    ```
 
 ---
 
