added README

README.md

@@ -1,87 +1,102 @@
 [![Go package](https://github.com/defang-io/defang/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/defang-io/defang/actions/workflows/go.yml)
 
 # Defang
+
 Defang is a radically simpler way for developers to create, deploy, and manage cloud applications.
 
 This repo includes:
-* Public releases of the Defang CLI; [click here](https://github.com/defang-io/defang/releases/latest/) for the latest version
-* Samples in Golang, Python, and Node.js that show how to accomplish various tasks and deploy them to the DOP using a Docker Compose file using the Defang CLI.
-* Samples that show how to deploy an app using the [Defang Pulumi Provider](https://github.com/defang-io/pulumi-defang).
+
+- Public releases of the Defang CLI; [click here](https://github.com/defang-io/defang/releases/latest/) for the latest version
+- Samples in Golang, Python, and Node.js that show how to accomplish various tasks and deploy them to the DOP using a Docker Compose file using the Defang CLI.
+- Samples that show how to deploy an app using the [Defang Pulumi Provider](https://github.com/defang-io/pulumi-defang).
 
 ## Getting started
-* Read our [Getting Started](https://docs.defang.io/docs/getting-started) page
-* Follow the installation instructions from the [Installing](https://docs.defang.io/docs/getting-started/installing) page
-* Take a look at our [Samples folder](https://github.com/defang-io/defang/tree/main/samples) for example projects in various programming languages.
-* Try the AI integration by running `defang generate`
-* Start your new service with `defang compose up`
+
+- Read our [Getting Started](https://docs.defang.io/docs/getting-started) page
+- Follow the installation instructions from the [Installing](https://docs.defang.io/docs/getting-started/installing) page
+- Take a look at our [Samples folder](https://github.com/defang-io/defang/tree/main/samples) for example projects in various programming languages.
+- Try the AI integration by running `defang generate`
+- Start your new service with `defang compose up`
 
 ## Installing
+
 Install the Defang CLI from one of the following sources:
-* Using the [Homebrew](https://brew.sh) package manager [defang-io/defang tap](https://github.com/defang-io/homebrew-defang):
+
+- Using the [Homebrew](https://brew.sh) package manager [defang-io/defang tap](https://github.com/defang-io/homebrew-defang):
   ```
   brew install defang-io/defang/defang
   ```
-* Using a shell script:
+- Using a shell script:
   ```
   . <(curl -Ls https://s.defang.io/install.sh)
   ```
-* Using [Go](https://go.dev):
+- Using [Go](https://go.dev):
   ```
   go install github.com/defang-io/defang/src/cmd/cli@latest
   ```
-* Using the [Nix package manager](https://nixos.org):
-  * with Nix-Env:
+- Using the [Nix package manager](https://nixos.org):
+  - with Nix-Env:
     ```
     nix-env -if https://github.com/defang-io/defang/archive/main.tar.gz
     ```
-  * or with Flakes:
+  - or with Flakes:
     ```
     nix profile install github:defang-io/defang#defang-bin --refresh
     ```
-* Download the [latest binary](https://github.com/defang-io/defang/releases/latest/) of the Defang CLI. For this beta, MacOS users will have to explicitly allow running of downloaded programs in the OS security settings.
+- Download the [latest binary](https://github.com/defang-io/defang/releases/latest/) of the Defang CLI. For this beta, MacOS users will have to explicitly allow running of downloaded programs in the OS security settings.
 
 ## Support
-* File any issues [right here on GitHub](https://github.com/defang-io/defang/issues)
+
+- File any issues [right here on GitHub](https://github.com/defang-io/defang/issues)
 
 ## Command completion
+
 The Defang CLI supports command completion for Bash, Zsh, Fish, and Powershell. To get the shell script for command completion, run the following command:
+
 ```
 defang completion [bash|zsh|fish|powershell]
 ```
 
 If you're using Bash, you can add the following to your `~/.bashrc` file:
+
 ```
 source <(defang completion bash)
 ```
 
 If you're using Zsh, you can add the following to your `~/.zshrc` file:
+
 ```
 source <(defang completion zsh)
 ```
+
 or pipe the output to a file called `_defang` in the directory with the completions.
 
 If you're using Fish, you can add the following to your `~/.config/fish/config.fish` file:
+
 ```
 defang completion fish | source
 ```
 
 If you're using Powershell, you can add the following to your `$HOME\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` file:
+
 ```
 Invoke-Expression -Command (defang completion powershell | Out-String)
 ```
 
 ## Environment Variables
+
 The Defang CLI recognizes the following environment variables:
-* `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the name in the `compose.yaml` file
-* `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login`
-* `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…`
-* `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta`
-* `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging
-* `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false`
-* `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev`
-* `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false`
-* `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false`
-* `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, or `defang`
-* `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
-* `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local`
-* `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state`
+
+- `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the name in the `compose.yaml` file
+- `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login`
+- `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…`
+- `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta`
+- `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging
+- `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false`
+- `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev`
+- `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false`
+- `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false`
+- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, or `defang`
+- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
+- `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local`
+- `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state`

samples/nodejs/svelte/README.md

@@ -0,0 +1,27 @@
+# Svelte TODO app
+
+This is a simple todoapp that uses Svelte as a frontend library, nodejs as backend, and mysql for database.
+
+## Technologies
+
+Create new tasks
+View existing tasks
+Update tasks
+Delete tasks
+(CRUD operations)
+
+## Essential Setup Files
+
+1. A <a href="https://docs.docker.com/develop/develop-images/dockerfile_best-practices/">Dockerfile</a>.
+2. A <a href="https://docs.defang.io/docs/concepts/compose">compose file</a> to define and run multi-container Docker applications (this is how Defang identifies services to be deployed).
+
+## Prerequisite
+
+1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
+2. If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account (optional)</a>
+
+## 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!