Merge branch 'main' into build/docker-compose-restart

Author: kshitij-k-osmosys

.github/workflows/backend.yml

@@ -8,15 +8,15 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '20'
+          node-version: '22'
 
       - name: Change to backend directory and install dependencies
         run: cd apps/api && npm install
@@ -27,15 +27,15 @@ jobs:
   build:
     needs: lint
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '20'
+          node-version: '22'
 
       - name: Change to backend directory and install dependencies
         run: cd apps/api && npm install

apps/api/Dockerfile

@@ -1,5 +1,5 @@
-# Use Node.js 20 as the base image
-FROM node:20
+# Use Node.js 22 as the base image
+FROM node:22
 
 # Set the working directory inside the container
 WORKDIR /app
@@ -26,4 +26,4 @@ RUN npm run build
 EXPOSE 3000
 
 # Command to start your NestJS application
-CMD ./scheduler.sh & node dist/main.js
+CMD ["sh", "-c", "./scheduler.sh & node dist/main.js"]

apps/api/Transcript Summarization.postman_collection.json

@@ -92,12 +92,10 @@
 							]
 						},
 						"url": {
-							"raw": "http://localhost:3000/graphql",
-							"protocol": "http",
+							"raw": "{{base_url}}/graphql",
 							"host": [
-								"localhost"
+								"{{base_url}}"
 							],
-							"port": "3000",
 							"path": [
 								"graphql"
 							]
@@ -186,12 +184,10 @@
 							]
 						},
 						"url": {
-							"raw": "http://localhost:3000/graphql",
-							"protocol": "http",
+							"raw": "{{base_url}}/graphql",
 							"host": [
-								"localhost"
+								"{{base_url}}"
 							],
-							"port": "3000",
 							"path": [
 								"graphql"
 							]
@@ -268,12 +264,10 @@
 							}
 						},
 						"url": {
-							"raw": "http://localhost:3000/graphql",
-							"protocol": "http",
+							"raw": "{{base_url}}/graphql",
 							"host": [
-								"localhost"
+								"{{base_url}}"
 							],
-							"port": "3000",
 							"path": [
 								"graphql"
 							]
@@ -337,12 +331,10 @@
 							}
 						},
 						"url": {
-							"raw": "http://localhost:3000/graphql",
-							"protocol": "http",
+							"raw": "{{base_url}}/graphql",
 							"host": [
-								"localhost"
+								"{{base_url}}"
 							],
-							"port": "3000",
 							"path": [
 								"graphql"
 							]
@@ -406,12 +398,10 @@
 							}
 						},
 						"url": {
-							"raw": "http://localhost:3000/graphql",
-							"protocol": "http",
+							"raw": "{{base_url}}/graphql",
 							"host": [
-								"localhost"
+								"{{base_url}}"
 							],
-							"port": "3000",
 							"path": [
 								"graphql"
 							]

apps/api/Transcript Summarization.postman_environment.json

@@ -0,0 +1,21 @@
+{
+	"id": "a513cfac-f3ec-4e78-a031-8fe55f62173a",
+	"name": "Transcript Summarization",
+	"values": [
+		{
+			"key": "auth-token",
+			"value": "MICROSOFT-AUTH-TOKEN",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "base_url",
+			"value": "BASE_URL",
+			"type": "default",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2025-06-16T08:18:51.860Z",
+	"_postman_exported_using": "Postman/11.49.4"
+}

apps/api/docs/usage-guide.md

@@ -73,16 +73,19 @@ When using the API, you'll need to set your **Microsoft authentication token** a
 2. Start the Portal
 3. Transcript Summarizer Portal should be running locally at `http://localhost:4200` (or `http://localhost:5000` for docker setup).
 4. Open the portal URL. You will be prompted to log in to your Microsoft account.
-5. Before proceeding, open developer tools (`ctrl+shift+i` OR `F12`) and open the **Network** tab.
-6. Login using your credentials. You will be directed to the Portal
-7. The request named `token` contains the Microsoft auth token that you can use for API.
+5. Before proceeding, open the developer tools of your browser. Popular shortcuts are `ctrl+shift+i` OR `F12`.
+6. Navigate to the **Network** tab.
+7. Login using your credentials. You will be directed to the Portal.
+8. Find the request labeled `token`. From its response data, extract the value associated with the key `access_token`.
+9. Use this extracted string as your Bearer token for authenticating API requests.
 
 ### Sending an API request
 
 Transcript Summarizer offers a GraphQL endpoint that allows you to upload transcript files and access all your summaries with advanced filtering options. For detailed information, please refer to the following:
 
 - [API documentation](./api-documentation.md)
 - [Postman Collection](./../Transcript%20Summarization.postman_collection.json)
+- [Postman Environment](./../Transcript%20Summarization.postman_environment.json)
 
 ## 5. Job Status Information