handling default

Author: karpikpl

.env

@@ -15,5 +15,5 @@ VUE_APP_GITHUB_ENT=
 VUE_APP_GITHUB_TOKEN=
 
 # GitHub Api Url
-# for proxy api - set to /api/github
-VUE_APP_GITHUB_API_URL=https://api.github.com
+# for proxy api - set to /api/github defaults to https://api.github.com
+VUE_APP_GITHUB_API=

README.md

@@ -157,18 +157,44 @@ For deployed version use the Uri of your app.
 
 To build and run the app with API proxy:
 
-```
-docker build -t copilot-metrics-viewer-with-api -f api.Dockerfile .
+```bash
+docker build -t copilot-metrics-viewer-with-proxy -f api.Dockerfile .
 ```
 
 To run:
 
+```bash
+docker run -it --rm -p 8080:3000 --env-file ./.env copilot-metrics-viewer-with-proxy
 ```
-docker run -it --rm -p 8080:3000 --env-file ./.env copilot-metrics-viewer-with-api
+
+Proxy can also run with token hardcoded on the backend (which hides it from frontend calls), here's a sample:
+
+```bash
+docker run -it --rm -p 3000:3000 \
+-e VUE_APP_SCOPE=enterprise \
+-e VUE_APP_GITHUB_API=/api/github  \
+-e VUE_APP_GITHUB_ENT=<enterprise name> \
+-e VUE_APP_GITHUB_TOKEN=<github PAT> \
+-e SESSION_SECRET=<random string>  \
+copilot-metrics-viewer-with-proxy
+```
+
+or
+
+```bash
+docker run -it --rm -p 3000:3000 \
+-e VUE_APP_SCOPE=organization \
+-e VUE_APP_GITHUB_API=/api/github  \
+-e VUE_APP_GITHUB_ORG=<org name> \
+-e VUE_APP_GITHUB_TOKEN=<github PAT> \
+-e SESSION_SECRET=<random string>   \
+copilot-metrics-viewer-with-api
 ```
 
 ### Github App Registration
 
+While it is possible to run API Proxy without GitHub app registration and with hardcoded token, it's the recommended way.
+
 Go to Organization -> Settings -> Developer Settings section -> GitHub Apps -> New GitHub App
 
 Replace <your org> with your organization name in the link:
@@ -230,7 +256,6 @@ docker run -it --rm -p 3000:3000 \
 ghcr.io/karpikpl/copilot-metrics-viewer-with-proxy
 ```
 
-
 ## License 
 
 This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE.txt) for the full terms.

src/config.ts

@@ -27,11 +27,11 @@ const baseApi = env.VUE_APP_GITHUB_API;
 let scopeName: string;
 if (scopeType === 'organization') {
 	scopeName = githubOrgName;
-	apiUrl = `${baseApi ?? 'https://api.github.com'}/orgs/${githubOrgName}`;
+	apiUrl = `${baseApi || 'https://api.github.com'}/orgs/${githubOrgName}`;
 }
 else if (scopeType === 'enterprise') {
 	scopeName = githubEntName;
-	apiUrl = `${baseApi ?? 'https://api.github.com'}/enterprises/${githubEntName}`;
+	apiUrl = `${baseApi || 'https://api.github.com'}/enterprises/${githubEntName}`;
 }
 else {
 	throw new Error(`Invalid VUE_APP_SCOPE value: ${env.VUE_APP_SCOPE}. Valid values: ${VALID_SCOPE.join(', ')}`)