Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto deploy #261

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions samples/javalin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ For development, we use a local container. This can be seen in the compose.yaml
docker compose 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
```

---

Title: Javalin
Expand Down
9 changes: 9 additions & 0 deletions samples/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ docker compose up --build

This will start a Docker container with the flask app which will display the result of the langchain prompt.

## 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
```
---

Title: LangChain & Flask
Expand Down
10 changes: 10 additions & 0 deletions samples/metabase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ Since Metabase is a self contained application, there isn't an actual developmen
3. Type `defang compose up` in the CLI.
4. Your app will be running within a few minutes.

## 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
```

---

Title: Metabase & PostgreSQL
Expand Down
9 changes: 9 additions & 0 deletions samples/nextjs-blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ This template is a starter project developed using Next.js designed to make it e
3. Type `defang compose up` in the CLI
4. Now your application will be launched

## 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
```
---

Title: Next.js Blog
Expand Down
4 changes: 3 additions & 1 deletion samples/nextjs-documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ This template is a documentation starter project developed using Nextra, designe

1. Download [Defang CLI](https://github.com/DefangLabs/defang)
2. If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc), make sure you have properly [authenticated your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
Plus, make sure that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
Plus, make sure that you have properly set your environment variables like
`AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
3. For any other config values that need to be set, please remember to configure with `defang config set API_KEY`

## A Step-by-Step Guide

Expand Down
10 changes: 10 additions & 0 deletions samples/nextjs-postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ This is a sample Next.js application that uses Postgres as a database. It is a s
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/)

## 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
```

## Development

To run the application locally, you can use the following command:
Expand Down
10 changes: 10 additions & 0 deletions samples/nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ A basic Next.js app with a Dockerfile and compose.yaml ready to deploy to AWS wi
3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
4. Run `defang compose up` in the root of this project

## 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
```

---

Title: Next.js
Expand Down
7 changes: 7 additions & 0 deletions samples/nocodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ For development, we use a local postgres container and a volume mount for file u

`docker compose --file compose.dev.yaml up --build`

## Configuration
If you wish to provide more configurations, see below for an example of setting a configuration for a value named `API_KEY`.

```bash
defang config set API_KEY
```

---

Title: NocoDB
Expand Down
10 changes: 10 additions & 0 deletions samples/nodejs-chatroom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ If you have environment variables configured for your [own cloud account](https:

```sh
defang compose up
```

## 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
```

---
Expand Down
10 changes: 10 additions & 0 deletions samples/nodejs-express/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ This Node.js application, built with Express.js, is designed to inspect and disp
2. Type `defang compose up` in the CLI
3. Your app should be up and running with Defang in minutes!

## 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
```

---

Title: Node.js & Express
Expand Down
10 changes: 10 additions & 0 deletions samples/nodejs-form/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ This is a basic Node.js application using the Express framework to demonstrate h
2. Type `defang compose up` in the CLI
3. Your app should be up and running with Defang in minutes!

## 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
```

---

Title: Node.js Express Form
Expand Down
10 changes: 10 additions & 0 deletions samples/nodejs-http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ If you have environment variables configured for your [own cloud account](https:
defang compose up
```

## 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
```

---

Title: Node.js HTTP Server
Expand Down
7 changes: 7 additions & 0 deletions samples/nodejs-openai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ or
```
cat prompt.txt | curl -H "Content-Type: application/text" -d @- https://xxxxxxxx/prompt
```
## Configuration

Please configure the `OPENAI_KEY` with

```bash
defang config set OPENAI_KEY
```

---

Expand Down
8 changes: 8 additions & 0 deletions samples/nodejs-react-postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ Or run without using Docker by doing the following:
4. Type `defang compose up` in the CLI.
5. Your app will be running within a few minutes.

## Configuration

For any other config values, please use

```bash
defang config set API_KEY
```

---

Title: Node.js & React & PostgreSQL
Expand Down
10 changes: 10 additions & 0 deletions samples/nodejs-rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

This is a simple Node.js application that uses Express.js to create a REST API. It has two endpoints: one that returns a status message, and another that fetches and returns average interest rates data from the U.S. Department of the Treasury's Fiscal Data API.

## 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
```

---

Title: Node.js & REST API
Expand Down
8 changes: 8 additions & 0 deletions samples/nodejs-s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ defang config set --name AWS_SECRET_KEY

and then enter the value when prompted.

## Configuration

If you wish to provide more configuration values, see below for an example of setting a configuration for a value named `API_KEY`.

```bash
defang config set API_KEY
```

## Testing

curl -X POST -H 'Content-Type: application/json' -d '{ "first_name" : "jane", "last_name" : "doe" }' https://xxxxxx/upload
Expand Down
10 changes: 10 additions & 0 deletions samples/ollama/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ 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 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 up` in a terminal that has access to your AWS environment variables.

## 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
```

---

Title: Ollama
Expand Down
7 changes: 7 additions & 0 deletions samples/phoenix-postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ docker compose -f compose.yaml -f compose.dev.yaml exec phoenix bash
3. Type `defang compose up` in the CLI.
4. Your app will be running within a few minutes.

## 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
```

---

Title: Phoenix & PostgreSQL
Expand Down
9 changes: 9 additions & 0 deletions samples/python-form/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,16 @@ This Flask application provides a basic example of handling form submissions. It
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!

## 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
```
---

Title: Python & Form
Expand Down
9 changes: 9 additions & 0 deletions samples/python-implicit-gpu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,16 @@ This Music Recommendation API provides artist recommendations based on collabora
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!

## 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
```
---

Title: Python & Implicit & GPU
Expand Down
10 changes: 10 additions & 0 deletions samples/python-minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ This Flask application is designed to inspect and return detailed information ab
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!

## 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
```

---

Expand Down
7 changes: 7 additions & 0 deletions samples/python-openai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ or
cat prompt.txt | curl -H "Content-Type: application/text" -d @- https://xxxxxxxx/prompt
```

## Configuration
If you wish to provide more config values, see below for an example of setting a configuration for a value named `API_KEY`.

```bash
defang config set API_KEY
```

---

Title: Python & Flask & OpenAI
Expand Down
9 changes: 9 additions & 0 deletions samples/python-rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ Endpoint to fetch average interest rates from the Fiscal Data Treasury API.
2. Type `defang compose up` in the CLI
3. Your app should be up and running with Defang in minutes!

## 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
```
---

Title: Python & REST API
Expand Down
7 changes: 7 additions & 0 deletions samples/python-s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ and then enter the value when prompted.
curl -X POST -H 'Content-Type: application/json' -d '{ "first_name" : "jane", "last_name" : "doe" }' https://xxxxxx/upload
curl https://xxxxxx/download

## Configuration
If you wish to provide more configuration values, see below for an example of setting a configuration for a value named `API_KEY`.

```bash
defang config set API_KEY
```

---

Title: Python & Flask & AWS S3
Expand Down
5 changes: 5 additions & 0 deletions samples/rails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ For this sample, you will need to provide the following [configuration](https://
### `POSTGRES_PASSWORD`
This password will be used to initialize the PostgreSQL database and to connect to it.

If you wish to provide more configuration values, see below for an example of setting a configuration for a value named `API_KEY`.

```bash
defang config set API_KEY
```

## Deployment

Expand Down
Loading
Loading