Release/1.2 - Main (#60)

Co-authored-by: Kevin Lan <[email protected]>
Co-authored-by: Austin-X <[email protected]>
Co-authored-by: minhhaitran08 <[email protected]>
Co-authored-by: Masahisa Sekita <[email protected]>
Co-authored-by: Austin-X <[email protected]>
Co-authored-by: dawangk <[email protected]>
Co-authored-by: kevin-lann <[email protected]>
Co-authored-by: MasahisaSekita <[email protected]>

Author: 6 people

.github/workflows/testing.yml

@@ -0,0 +1,11 @@
+name: Run Tests
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run frontend tests
+      run: cd course-matrix/frontend && npm install && npm run test
+    - name: Run backend tests
+      run: cd course-matrix/backend && npm install && npm run test

.github/workflows/workflow.yml

@@ -0,0 +1,22 @@
+name: Format the code
+
+on:
+  push:
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    name: Format Files
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+      - name: Prettier
+        run: npx prettier --write **/*.{js,ts,tsx,json,md}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
+        with:
+          commit_message: "Auto-formatted the code using Prettier"

README.md

@@ -49,17 +49,20 @@ PORT=8081
 CLIENT_APP_URL="http://localhost:5173"
 DATABASE_URL=[Insert Supabase Project URL]
 DATABASE_KEY=[Insert Supabase Project API key]
+
+OPENAI_API_KEY=[Insert OpenAI API Key]
+PINECONE_API_KEY=[Insert Pinecone API Key]
+PINECONE_INDEX_NAME="course-matrix"
 ```
 
-The `DATABASE_URL` variable should contain your Supabase project url and the `DATABASE_KEY` should contain your Supabase project’s API key. To learn how to create a new Supabase project: see [here](https://medium.com/@heshramsis/building-a-crud-app-with-supabase-and-express-a-step-by-step-guide-for-junior-developers-81456b850910). Note that for the purposes of this project, we will provide the grader with all necessary API keys and URLs.
+The `DATABASE_URL` variable should contain your Supabase project url and the `DATABASE_KEY` should contain your Supabase project’s API key. To learn how to create a new Supabase project: see [here](https://medium.com/@heshramsis/building-a-crud-app-with-supabase-and-express-a-step-by-step-guide-for-junior-developers-81456b850910). Likewise, the `OPENAI_API_KEY` variable should contain your OpenAI Project API Key and the `PINECONE_API_KEY` should contain your Pinecone Project API Key. Note that for the purposes of this project, **we will provide the grader with all necessary API keys and URLs**.
 
 4. Configure environment variables for frontend. Create a `.env` file in `/frontend` and populate it with the following:
 
 ```
 VITE_SERVER_URL="http://localhost:8081"
 ```
 
-
 ### Running the Application
 
 To run the application locally:

course-matrix/backend/__tests__/index.test.ts

@@ -0,0 +1,18 @@
+import { describe, test, expect } from "@jest/globals";
+import request from "supertest";
+import app from "../src/index";
+
+describe("Sum function", () => {
+  test("Returns correct value", () => {
+    expect(2 + 3).toEqual(5);
+  });
+});
+
+// Will finish the rest of the tests below in Sprint 3
+
+// describe("GET /auth/session", () => {
+// 	test("It should respond with 200 status", async () => {
+// 		const response = await request(app).get("/auth/session");
+// 		expect(response.statusCode).toBe(200);
+// 	});
+// });

course-matrix/backend/jest.config.ts

@@ -0,0 +1,25 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  preset: "ts-jest",
+  moduleNameMapper: {
+    "\\.(css|scss)$": "identity-obj-proxy",
+    "^.+\\.svg": "<rootDir>/tests/mocks/svgMock.tsx",
+  },
+  // to obtain access to the matchers.
+  setupFilesAfterEnv: ["<rootDir>/tests/setupTests.ts"],
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  modulePaths: ["<rootDir>"],
+  testEnvironment: "jsdom",
+  transform: {
+    "^.+\\.(ts|tsx)$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.test.json",
+      },
+    ],
+    "^.+\\.(js|jsx)$": "babel-jest",
+  },
+};
+
+export default config;