Skip to content

Commit 4cb96e8

Browse files
committed
misc readme updates
1 parent 209a9f5 commit 4cb96e8

File tree

6 files changed

+208
-76
lines changed

6 files changed

+208
-76
lines changed

samples/angular-express/README.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,56 @@
22

33
[![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)
44

5-
This project demonstrates both client-side component rendering and hydration with Angular, as well as server-side rendering with Node.js and Socket.IO for real-time communication. It also includes Docker configurations for easy deployment.
5+
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.
66

7-
## NOTE
7+
## Prerequisites
88

9-
This sample showcases how you could deploy a full-stack application with Angular and Node.js using Defang. The Docker setup ensures the app can be easily built and deployed.
9+
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
10+
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
11+
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
12+
4. Install [Node.js](https://nodejs.org/en/download/package-manager/)
13+
5. Install [Angular CLI](https://angular.io/cli)
1014

11-
## Essential Setup Files
15+
## Development
16+
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.
1217

13-
1. Download [Defang CLI](https://github.com/defang-io/defang)
14-
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
15-
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
18+
To run the application locally, you can use the following command:
1619

17-
## Prerequisites
20+
```bash
21+
docker compose -f compose.dev.yaml up --build
22+
```
1823

19-
1. Download [Defang CLI](https://github.com/defang-io/defang)
20-
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
21-
3. [Node.js](https://nodejs.org/en/download/package-manager/)
22-
4. [Angular CLI](https://angular.io/cli)
24+
## Configuration
2325

24-
## A Step-by-Step Guide for deployment
26+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
2527

26-
1. Open the terminal and type `defang login`
27-
2. Type `defang compose up` in the CLI
28-
3. Your app should be up and running with Defang in minutes!
28+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
2929

30-
## Development
30+
```bash
31+
defang config set API_KEY
32+
```
33+
34+
## Deployment
35+
36+
> [!NOTE]
37+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
38+
39+
### Defang Playground
40+
41+
Deploy your application to the Defang Playground by opening up your terminal and typing:
42+
```bash
43+
defang compose up
44+
```
45+
46+
### BYOC (AWS)
3147

32-
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 sample locally after cloning the repository, you can run on Docker by doing:
48+
If you want to deploy to your own cloud account, you can use Defang BYOC:
3349

34-
1. `docker compose -f compose.dev.yaml up --build`
50+
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`.
51+
2. Run in a terminal that has access to your AWS environment variables:
52+
```bash
53+
defang --provider=aws compose up
54+
```
3555

3656
---
3757

@@ -41,4 +61,4 @@ Short Description: A full-stack application using Angular for the frontend and N
4161

4262
Tags: Angular, Node.js, Socket.IO, TypeScript, JavaScript
4363

44-
Languages: nodejs
64+
Languages: nodejs

samples/csharp-dotnet/README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,64 @@
22

33
[![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-csharp-dotnet-template%26template_owner%3DDefangSamples)
44

5-
This project is a simple task manager application using ASP.NET Core. We show case how to deploy it to both Defang and Docker for both prod and dev environments.
5+
This sample project is a simple task manager application using ASP.NET Core for the backend and JavaScript for client-side component rendering.
66

7-
## NOTE
7+
It 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.
88

9-
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.
10-
11-
## Essential Setup Files
9+
## Prerequisites
1210

13-
1. Download [Defang CLI](https://github.com/defang-io/defang)
14-
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
11+
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
12+
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
1513
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
14+
4. Install [ASP.NET Core](https://dotnet.microsoft.com/download/dotnet-core)
1615

17-
## Prerequisites
16+
## Development
1817

19-
1. Download [Defang CLI](https://github.com/defang-io/defang)
20-
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
21-
3. [ASP.NET Core](https://dotnet.microsoft.com/download/dotnet-core)
18+
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.
2219

23-
## A Step-by-Step Guide for deployment
20+
To run the application locally, you can use the following command:
2421

25-
1. Open the terminal and type `defang login`
26-
2. Type `defang compose up` in the CLI
27-
3. Your app should be up and running with Defang in minutes!
22+
```bash
23+
docker compose -f compose.dev.yaml up --build
24+
```
25+
## Configuration
2826

29-
## Development
27+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
28+
29+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
30+
31+
```bash
32+
defang config set API_KEY
33+
```
34+
35+
## Deployment
36+
37+
> [!NOTE]
38+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
39+
40+
### Defang Playground
41+
42+
Deploy your application to the Defang Playground by opening up your terminal and typing:
43+
```bash
44+
defang compose up
45+
```
46+
47+
### BYOC (AWS)
3048

31-
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:
49+
If you want to deploy to your own cloud account, you can use Defang BYOC:
3250

33-
`docker compose -f compose.dev.yaml up --build`
51+
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`.
52+
2. Run in a terminal that has access to your AWS environment variables:
53+
```bash
54+
defang --provider=aws compose up
55+
```
3456

3557
---
3658

3759
Title: C# & ASP.NET Core
3860

39-
Short Description: A task manager using ASP.NET Core containerized with Docker.
61+
Short Description: A simple task manager application using C# and ASP.NET Core.
4062

4163
Tags: ASP.NET Core, JavaScript, C#
4264

43-
Languages: C#
65+
Languages: C#

samples/elysia/README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,48 @@ A basic [Elysia](https://elysiajs.com/) app running on [Bun](https://bun.sh/) wi
77
## Prerequisites
88

99
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
10-
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
11-
3. (Optional - for local development) [Docker CLI](https://docs.docker.com/engine/install/)
10+
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
11+
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
1212

13-
## Deploying
13+
## Development
1414

15-
1. Run `defang login` if you are not yet logged in.
16-
2. Run `defang compose up`.
17-
3. Your app will be running within a few minutes.
15+
To run the application locally, you can use the following command:
1816

19-
## Local Development
17+
```bash
18+
docker compose -f compose.dev.yaml up --build
19+
```
2020

21-
1. Run `docker compose -f compose.dev.yaml up --build`
21+
## Configuration
22+
23+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
24+
25+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
26+
27+
```bash
28+
defang config set API_KEY
29+
```
30+
31+
## Deployment
32+
33+
> [!NOTE]
34+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
35+
36+
### Defang Playground
37+
38+
Deploy your application to the Defang Playground by opening up your terminal and typing:
39+
```bash
40+
defang compose up
41+
```
42+
43+
### BYOC (AWS)
44+
45+
If you want to deploy to your own cloud account, you can use Defang BYOC:
46+
47+
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`.
48+
2. Run in a terminal that has access to your AWS environment variables:
49+
```bash
50+
defang --provider=aws compose up
51+
```
2252

2353
---
2454

samples/feathersjs/README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,51 @@ This sample project demonstrates how to deploy a FeathersJS application on to AW
66

77
## Prerequisites
88

9-
1. Download [Defang CLI](https://github.com/DefangLabs/defang) (for Defang deployment)
10-
2. (Optional - for local development) [Docker CLI](https://docs.docker.com/engine/install/)
9+
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
10+
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
11+
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
1112
3. (Optional - for local development) [Node.js](https://nodejs.org/en/download/)
1213

13-
### Local Development
14-
14+
## Development
1515
For development, we use Docker to containerize the FeathersJS application. The Docker Compose configuration is defined in the `compose.dev.yaml` file.
1616

17-
To start the development environment, run:
17+
To run the application locally, you can use the following command:
1818

19-
```sh
19+
```bash
2020
docker compose -f compose.dev.yaml up --build
2121
```
2222

23-
# Deploying
23+
## Configuration
24+
25+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
26+
27+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
28+
29+
```bash
30+
defang config set API_KEY
31+
```
32+
33+
## Deployment
34+
35+
> [!NOTE]
36+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
37+
38+
### Defang Playground
39+
40+
Deploy your application to the Defang Playground by opening up your terminal and typing:
41+
```bash
42+
defang compose up
43+
```
44+
45+
### BYOC (AWS)
46+
47+
If you want to deploy to your own cloud account, you can use Defang BYOC:
2448

25-
1. Open the terminal and type defang login
26-
2. Type `defang compose up` in the CLI.
27-
3. Your app will be running within a few minutes.
49+
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`.
50+
2. Run in a terminal that has access to your AWS environment variables:
51+
```bash
52+
defang --provider=aws compose up
53+
```
2854

2955
---
3056

samples/flask/README.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,61 @@
22

33
[![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-flask-template%26template_owner%3DDefangSamples)
44

5-
This is a sample of a basic Flask TODO app. The items are stored in memory and are lost when the server is restarted, but it should give you a basic idea of how to get started with Flask on Defang. Note that alognside your .py file, include a requirements.txt so that the Dockerfile can install the necessary packages with pip.
5+
This is a basic Flask to-do app that can be deployed with Defang. Note that alongside your `.py` file, include a `requirements.txt` so that the Dockerfile can install the necessary packages with pip.
66

7-
### NOTE:
7+
This project is intended to provide a basic understanding of how to get started with Flask on Defang. The items are stored in memory and are lost when the server is restarted. **It is not intended for production use**. If you need something production ready, you should use a managed database like Postgres or MySQL.
88

9-
This sample is a simple Flask app that demonstrates how to create a TODO app using Flask. The items are stored in memory and are lost when the server is restarted. This sample is intended to provide a basic understanding of how to get started with Flask on Defang. **it is not intended for production use**. If you need something production ready, you should use a managed database like Postgres or MySQL.
9+
## Prerequisites
1010

11-
## Essential Setup Files
11+
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
12+
2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
13+
3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
1214

13-
1. A [Dockerfile](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/).
14-
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).
15-
3. A [.dockerignore](https://docs.docker.com/build/building/context/#dockerignore-files) to ignore files that are not needed in the Docker image or will be generated during the build process.
15+
## Development
1616

17-
## Prerequisite
17+
To run the application locally, you can use the following command:
1818

19-
1. Download [Defang CLI](https://github.com/DefangLabs/defang)
20-
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)
19+
```bash
20+
docker compose up --build
21+
```
22+
23+
## Configuration
24+
25+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
26+
27+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
28+
29+
```bash
30+
defang config set API_KEY
31+
```
32+
33+
## Deployment
34+
35+
> [!NOTE]
36+
> Download [Defang CLI](https://github.com/DefangLabs/defang)
37+
38+
### Defang Playground
39+
40+
Deploy your application to the Defang Playground by opening up your terminal and typing:
41+
```bash
42+
defang compose up
43+
```
2144

22-
## A Step-by-Step Guide
45+
### BYOC (AWS)
2346

24-
1. Open the terminal and type `defang login`
25-
2. Type `defang compose up` in the CLI
26-
3. Your app should be up and running with Defang in minutes!
47+
If you want to deploy to your own cloud account, you can use Defang BYOC:
2748

28-
## One click deployment
49+
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`.
50+
2. Run in a terminal that has access to your AWS environment variables:
51+
```bash
52+
defang --provider=aws compose up
53+
```
2954

3055
---
3156

3257
Title: Flask
3358

34-
Short Description: A basic Flask to do app.
59+
Short Description: A basic Flask to-do app.
3560

3661
Tags: Flask, Python
3762

samples/html-css-js/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![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)
44

5-
This sample shows how to get a static HTML + CSS + JavaScript website up and running with Defang.
5+
This sample shows how to get a static HTML, CSS and JavaScript website up and running with Defang.
66

77
## Prerequisites
88

@@ -18,6 +18,15 @@ To run the application locally, you can use the following command:
1818
docker compose up --build
1919
```
2020

21+
## Configuration
22+
23+
For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration).
24+
25+
If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
26+
27+
```bash
28+
defang config set API_KEY
29+
```
2130

2231
## Deployment
2332

@@ -44,7 +53,7 @@ If you want to deploy to your own cloud account, you can use Defang BYOC:
4453

4554
Title: HTML & CSS & JavaScript
4655

47-
Short Description: A simple HTML + CSS + JavaScript website running on Defang.
56+
Short Description: A simple HTML, CSS and JavaScript website running on Defang.
4857

4958
Tags: HTML, CSS, JavaScript, Frontend
5059

0 commit comments

Comments
 (0)