Merge pull request #301 from DefangLabs/linda-nodejs

Update nodejs samples

Author: raphaeltm

README.md

@@ -2,30 +2,62 @@
 
 [![1-click-deploy](https://defang.io/deploy-with-defang.svg)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-nodejs-openai-template%26template_owner%3DDefangSamples)
 
-## Setup
+A simple Node.js and OpenAI app deployed using Defang.
 
-This sample requires an API key to access the OpenAI API. The name of the config value is referenced in the compose.yaml file.
-To provide a value for it, you can use the Defang CLI like this:
+## Prerequisites
 
-```
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+
+## Development
 
-defang config set --name OPENAI_KEY
+To run the application locally, you can use the following command:
+
+```bash
+docker compose up --build
 ```
 
-and then enter the value when prompted.
+## Configuration
+For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration): 
 
-## Testing
+> 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.
 
+### `OPENAI_KEY`
+An API key to access the OpenAI API.
+```bash
+defang config set OPENAI_KEY
 ```
+
+## Testing
+Below are some useful commands for testing. 
+
+```bash
 echo "Hello" | curl -H "Content-Type: text/plain" -d @- https://xxxxxxxx/prompt
 ```
 
-or
+or alternatively,
 
-```
+```bash
 cat prompt.txt | curl -H "Content-Type: application/text" -d @- https://xxxxxxxx/prompt
 ```
 
+## 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](https://docs.defang.io/docs/tutorials/deploy-to-your-cloud):
+
 ---
 
 Title: Node.js & OpenAI