*nix codestyle

.editorconfig

@@ -8,6 +8,10 @@ root = true
 indent_style = space
 end_of_line = lf
 
+# Bash scripts
+[*.sh]
+indent_size = 2
+
 # XML project files
 [*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
 indent_size = 2

.github/workflows/copilot-build-frontend.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Run yarn install, yarn build, & yarn format
         run: |
-          #!/bin/bash
+          #!/usr/bin/env bash
           set -e # exit with nonzero exit code if anything fails
           echo "Running yarn install, yarn build, & yarn format"
           yarn install --frozen-lockfile # install dependencies and ensure lockfile is unchanged.

.vscode/settings.json

@@ -49,4 +49,6 @@
       "**/Thumbs.db": true,
       "**.lock": true,
     },
+    "dotnet.defaultSolution": "CopilotChat.sln",
+    "editor.tabSize": 2,
   }

README.md

@@ -73,46 +73,64 @@ You will need the following items to run the sample:
 
    ```bash
    cd <path to chat-copilot>/scripts/
-   chmod +x *.sh
-   ```
+      ```
 
    **Ubuntu/Debian Linux**
 
    ```bash
-   ./Install-apt.sh
+   ./install-apt.sh
    ```
 
    > NOTE: This script uses `apt` to install `dotnet-sdk-7.0`, `nodejs`, and `yarn`.
 
    **macOS**
 
    ```bash
-   ./Install-brew.sh
+   ./install-brew.sh
    ```
 
    > NOTE: This script uses `homebrew` to install `dotnet-sdk`, `nodejs`, and `yarn`.
 
 3. Configure Chat Copilot.
 
-   ```bash
-   ./Configure.sh --aiservice {AI_SERVICE} --apikey {API_KEY} --endpoint {AZURE_OPENAI_ENDPOINT}
-   ```
+   1. For OpenAI
 
-   - `AI_SERVICE`: `AzureOpenAI` or `OpenAI`.
-   - `API_KEY`: The `API key` for Azure OpenAI or for OpenAI.
-   - `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address. Omit `--endpoint` if using OpenAI.
+      ```bash
+      ./configure.sh --aiservice OpenAI --apikey {API_KEY}
+      ```
 
+      - `API_KEY`: The `API key` for OpenAI.
 
-   - > **IMPORTANT:** For `AzureOpenAI`, if you deployed models `gpt-35-turbo` and `text-embedding-ada-002` with custom names (instead of each own's given name), also use the parameters:
 
-     ```bash
-     --completionmodel {DEPLOYMENT_NAME} --embeddingmodel {DEPLOYMENT_NAME} --plannermodel {DEPLOYMENT_NAME}
-     ```
+   2. For Azure OpenAI
+
+      ```bash
+      ./configure.sh --aiservice AzureOpenAI \
+                     --endpoint {AZURE_OPENAI_ENDPOINT} \
+                     --apikey   {API_KEY} 
+      ```
+
+      - `AZURE_OPENAI_ENDPOINT`: The Azure OpenAI resource `Endpoint` address.
+      - `API_KEY`: The `API key` for Azure OpenAI.
+
+
+      **IMPORTANT:** If you deployed models `gpt-35-turbo` and `text-embedding-ada-002`
+      with custom names (instead of each own's given name), you need to specify
+      the deployment names with three additional parameters:
+
+      ```bash
+      ./configure.sh --aiservice AzureOpenAI \
+                     --endpoint        {AZURE_OPENAI_ENDPOINT} \
+                     --apikey          {API_KEY} \
+                     --completionmodel {DEPLOYMENT_NAME} \
+                     --plannermodel    {DEPLOYMENT_NAME} \
+                     --embeddingmodel  {DEPLOYMENT_NAME}
+      ```
 
 4. Run Chat Copilot locally. This step starts both the backend API and frontend application.
 
    ```bash
-   ./Start.sh
+   ./start.sh
    ```
 
    It may take a few minutes for Yarn packages to install on the first run.
@@ -199,7 +217,7 @@ By default, Chat Copilot runs locally without authentication, using a guest user
 
     **Bash**
     ```bash
-    ./Configure.sh --aiservice {AI_SERVICE} --apikey {API_KEY} --endpoint {AZURE_OPENAI_ENDPOINT} --frontend-clientid {FRONTEND_APPLICATION_ID} --backend-clientid {BACKEND_APPLICATION_ID} --tenantid {TENANT_ID} --instance {AZURE_AD_INSTANCE}
+    ./configure.sh --aiservice {AI_SERVICE} --apikey {API_KEY} --endpoint {AZURE_OPENAI_ENDPOINT} --frontend-clientid {FRONTEND_APPLICATION_ID} --backend-clientid {BACKEND_APPLICATION_ID} --tenantid {TENANT_ID} --instance {AZURE_AD_INSTANCE}
     ```
 
     - `AI_SERVICE`: `AzureOpenAI` or `OpenAI`.
@@ -221,7 +239,7 @@ By default, Chat Copilot runs locally without authentication, using a guest user
     **Bash**
 
     ```bash
-    ./Start.sh
+    ./start.sh
      ```
 
 # Troubleshooting

scripts/Configure.sh → scripts/configure.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # Configure user secrets, appsettings.Development.json, and webapp/.env for Chat Copilot.
 
 set -e

scripts/deploy/deploy-azure.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Deploy Chat Copilot Azure resources.
 

scripts/deploy/deploy-webapi.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Deploy CopilotChat's WebAPI to Azure.
 

scripts/deploy/deploy-webapp.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Deploy CopilotChat's WebApp to Azure
 

scripts/deploy/package-webapi.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Package CiopilotChat's WebAPI for deployment to Azure
 

scripts/Install-apt.sh → scripts/install-apt.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Installs the requirements for running Chat Copilot.
 

scripts/Install-brew.sh → scripts/install-brew.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Installs the requirements for running Chat Copilot.
 

scripts/Start-Backend.sh → scripts/start-backend.sh

@@ -1,11 +1,11 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Builds and runs the Chat Copilot backend.
 
 set -e
 
 # Stop any existing backend API process
-while pid=$(pgrep CopilotChatWebA); do 
+while pid=$(pgrep CopilotChatWebA); do
     echo $pid | sed 's/\([0-9]\{4\}\) .*/\1/' | xargs kill
 done
 
@@ -14,7 +14,7 @@ SCRIPT_DIRECTORY="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 . $SCRIPT_DIRECTORY/.env
 cd "$SCRIPT_DIRECTORY/../webapi"
 
-# Environment variable `ASPNETCORE_ENVIRONMENT` required to override appsettings.json with 
+# Environment variable `ASPNETCORE_ENVIRONMENT` required to override appsettings.json with
 # appsettings.$ENV_ASPNETCORE.json. See `webapi/ConfigurationExtensions.cs`
 export ASPNETCORE_ENVIRONMENT=$ENV_ASPNETCORE
 

scripts/Start-Frontend.sh → scripts/start-frontend.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Builds and runs the Chat Copilot frontend.
 

scripts/Start.sh → scripts/start.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Initializes and runs both the backend and frontend for Copilot Chat.
 
@@ -8,7 +8,7 @@ ScriptDir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 cd "$ScriptDir"
 
 # Start backend (in background)
-./Start-Backend.sh &
+./start-backend.sh &
 
 # Start frontend
-./Start-Frontend.sh
+./start-frontend.sh