Merge pull request #9 from github-copilot-community/feature/mocked-data

Update environment variables and resolve JSON module in tsconfig.json

Author: martedesco

.env

@@ -1,2 +1,5 @@
+VUE_APP_MOCKED_DATA=true
+
 VUE_APP_GITHUB_ORG=
+
 VUE_APP_GITHUB_TOKEN=

README.md

@@ -54,7 +54,13 @@ Your organization must be enrolled in the GitHub Copilot API private alpha.
 ## Setup instructions
 
 - Instructions on how to authenticate are provided in the API documentation - available if you have access to the private alpha.
-- Edit the .env file in the root directory of the project and add the following variables:
+
+### .env file setup
+- To utilize mocked data stored in a JSON file, simply set the following boolean environment variable to true:
+```
+  VUE_APP_MOCKED_DATA=true
+```
+- To access Copilot metrics through the API, update your configuration by adding the following variables:
 
 ```
   VUE_APP_GITHUB_ORG=

src/api/GitHubApi.ts

@@ -5,22 +5,31 @@
 //Return the response from the API
 
 import axios from "axios";
+
 import { Metrics } from "../model/MetricsData";
+import data from '../assets/copilot_metrics_response_sample.json';
 
 export const getGitHubCopilotMetricsApi = async (): Promise<Metrics[]> => {
-  const response = await axios.get(
-    `https://api.github.com/orgs/${process.env.VUE_APP_GITHUB_ORG}/copilot/usage`,
-    {
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${process.env.VUE_APP_GITHUB_TOKEN}`,
-        "X-GitHub-Api-Version": "2022-11-28",
-      },
-    }
-  );
+  
+  let response;
+  let metricsData;
 
-  // Map the response data to an array of Metrics objects
-  const metricsData = response.data.map((item: any) => new Metrics(item));
+  if (process.env.VUE_APP_MOCKED_DATA === "true") {
+    response = data;
+    metricsData = response.map((item: any) => new Metrics(item));
+  } else {
+    response = await axios.get(
+      `https://api.github.com/orgs/${process.env.VUE_APP_GITHUB_ORG}/copilot/usage`,
+      {
+        headers: {
+          Accept: "application/vnd.github+json",
+          Authorization: `Bearer ${process.env.VUE_APP_GITHUB_TOKEN}`,
+          "X-GitHub-Api-Version": "2022-11-28",
+        },
+      }
+    );
 
+    metricsData = response.data.map((item: any) => new Metrics(item));
+  }
   return metricsData;
 };