Repo organization: doc fixes, scripting, scaffolding for testing, linting, etc.

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: Repo Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: frontend/package-lock.json
+      - name: Run checks
+        run: npm run gitcheck

.gitignore

@@ -11,6 +11,8 @@
 .next
 out
 node_modules
+coverage
+.vercel
 
 # OS/Editor cruft
 .DS_Store

.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+.next
+out
+.supabase
+coverage
+**/package-lock.json

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "printWidth": 100,
+  "singleQuote": false,
+  "semi": true
+}

README.md

@@ -20,6 +20,62 @@ Students struggle to find consolidated, high‑quality, course‑specific study
 - [Wieland Rodriguez](https://www.linkedin.com/in/wieland-rodriguez) - Developer
 - [Emma Walker](https://www.linkedin.com/) - Developer
 
+## Getting Started
+
+The fastest way to get up and running is the setup script. It checks your local
+dependencies, verifies environment variables, installs packages, and then starts
+the dev server only when everything looks good.
+
+```bash
+npm run setup
+```
+
+### What the setup script checks
+- Node.js is installed and prints the version.
+- Supabase CLI is installed (or it will tell you how to install it).
+- Required environment variables exist in `frontend/.env.local`.
+- Frontend dependencies are installed.
+
+### Supabase CLI install (Windows)
+Run this in PowerShell:
+
+```powershell
+Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
+iwr -useb get.scoop.sh | iex
+scoop install supabase
+```
+
+### Supabase CLI install (macOS)
+
+```bash
+brew install supabase/tap/supabase
+```
+
+### Required environment variables
+Create `frontend/.env.local` and include:
+- `NEXT_PUBLIC_SUPABASE_URL`
+- `NEXT_PUBLIC_SUPABASE_ANON_KEY`
+- `SUPABASE_SERVICE_ROLE_KEY`
+
+### Start the dev server
+If you want to skip the full checks and just start after installing updates:
+
+```bash
+npm run start
+```
+
+### Auth flow
+Open `/auth`, enter your `@calpoly.edu` email, and use the one-time code to log in.
+After that, you will be routed to onboarding or the dashboard.
+
+## Documentation
+
+- Product requirements: `docs/PRD.md`
+- Tech stack: `docs/Note_Sharer_Tech_Stack.md`
+- Project charter: `docs/project-charter.md`
+- Contributing: `docs/contributing.md`
+- PR review guide: `docs/PR_REVIEW_GUIDE.md`
+
 ## Contributing
 
 Visit [contributing.md](docs/contributing.md) on info for how to contribute to this repo.

frontend/__tests__/nicknames.test.ts

@@ -0,0 +1,13 @@
+import { generateRandomNickname, generateRandomNicknames } from "@/lib/nicknames";
+
+describe("nicknames", () => {
+  it("generates a nickname with letters and digits", () => {
+    const nickname = generateRandomNickname();
+    expect(nickname).toMatch(/^[A-Za-z]+[A-Za-z]+[0-9]{1,2}$/);
+  });
+
+  it("generates the requested count", () => {
+    const nicknames = generateRandomNicknames(3);
+    expect(nicknames).toHaveLength(3);
+  });
+});

frontend/app/api/course-submissions/route.ts

@@ -40,6 +40,7 @@ export async function POST(request: Request) {
   let payload: SubmissionPayload;
   try {
     payload = (await request.json()) as SubmissionPayload;
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   } catch (error) {
     return NextResponse.json(
       { error: "Invalid request payload." },

frontend/app/auth/page.tsx

@@ -19,7 +19,6 @@ export default function AuthPage() {
     const checkSession = async () => {
       const { data, error } = await supabase.auth.getSession();
       if (error) {
-        // eslint-disable-next-line no-console
         console.error("Failed to fetch session", error);
       }
       if (data?.session) {

frontend/app/dashboard/page.tsx

@@ -55,6 +55,7 @@ export default function DashboardPage() {
   const [noteSearch, setNoteSearch] = useState("");
   const [accessToken, setAccessToken] = useState<string | null>(null);
   const [tokenLoaded, setTokenLoaded] = useState(false);
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const [isUploadOpen, setIsUploadOpen] = useState(false);
 
   const [isCourseRequestOpen, setIsCourseRequestOpen] = useState(false);
@@ -114,6 +115,7 @@ export default function DashboardPage() {
         }
         const data = await res.json();
         setClasses(data.classes || []);
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (err) {
         setClassesError("Failed to load classes");
         setClasses([]);
@@ -150,6 +152,7 @@ export default function DashboardPage() {
       setFreeDownloads(
         Number.isFinite(data?.freeDownloads) ? Number(data.freeDownloads) : 0,
       );
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       setCredits(null);
       setFreeDownloads(null);
@@ -218,6 +221,7 @@ export default function DashboardPage() {
         }
 
         setHasMore(Boolean(data.hasMore));
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (err) {
         setNotesError("Unexpected error fetching notes");
         setHasMore(false);
@@ -328,6 +332,7 @@ export default function DashboardPage() {
       setCourseRequestStatus("success");
       setCourseRequestMessage("Request submitted. We will review it soon.");
       setCourseRequest(emptyCourseRequest);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       setCourseRequestStatus("error");
       setCourseRequestMessage("Failed to submit the request. Try again.");

frontend/app/onboarding/page.tsx

@@ -53,7 +53,6 @@ export default function OnboardingPage() {
       const nickname = await generateUniqueNickname(supabase);
       setDisplayName(nickname);
     } catch (generationError) {
-      // eslint-disable-next-line no-console
       console.error("Failed to generate nickname", generationError);
       setError("Unable to generate a nickname. Please try again.");
     } finally {
@@ -77,7 +76,6 @@ export default function OnboardingPage() {
         nameToSave = await generateUniqueNickname(supabase);
         setDisplayName(nameToSave);
       } catch (generationError) {
-        // eslint-disable-next-line no-console
         console.error("Failed to generate nickname", generationError);
         setError("Unable to generate a nickname. Please try again.");
         setSaving(false);

frontend/app/test-upload/page.tsx

@@ -1,13 +1,15 @@
 // app/test-upload/page.tsx
 "use client";
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type { Session } from "@supabase/supabase-js";
 import { useState, useEffect } from "react";
 import { useRouter } from "next/navigation";
 import { supabase } from "@/lib/supabaseClient";
 
 export default function TestUploadPage() {
   const router = useRouter();
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const [ isAuthenticated, setIsAuthenticated] = useState(false);
 
   const [file, setFile] = useState<File | null>(null);

frontend/app/upload/page.tsx

@@ -198,6 +198,7 @@ export default function UploadPage() {
       setCourseRequestStatus("success");
       setCourseRequestMessage("Request submitted. We will review it soon.");
       setCourseRequest(emptyCourseRequest);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       setCourseRequestStatus("error");
       setCourseRequestMessage("Failed to submit the request. Try again.");
@@ -240,6 +241,7 @@ export default function UploadPage() {
         }
         const data = await res.json();
         setClasses(data.classes || []);
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       } catch (err) {
         setClassesError("Failed to load classes");
         setClasses([]);
@@ -333,6 +335,7 @@ export default function UploadPage() {
 
       setResult(`${res.status}: ${JSON.stringify(payload)}`);
       setIsSuccess(true);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     } catch (error) {
       setSubmitError("Upload failed. Please check your connection and retry.");
     } finally {

frontend/eslint.config.mjs

@@ -5,6 +5,12 @@ import nextTs from "eslint-config-next/typescript";
 const eslintConfig = defineConfig([
   ...nextVitals,
   ...nextTs,
+  {
+    files: ["**/*.cjs"],
+    rules: {
+      "@typescript-eslint/no-require-imports": "off",
+    },
+  },
   // Override default ignores of eslint-config-next.
   globalIgnores([
     // Default ignores of eslint-config-next:

frontend/jest.config.cjs

@@ -0,0 +1,13 @@
+const nextJest = require("next/jest");
+
+const createJestConfig = nextJest({ dir: "./" });
+
+const customJestConfig = {
+  testEnvironment: "node",
+  moduleNameMapper: {
+    "^@/(.*)$": "<rootDir>/$1",
+  },
+  testPathIgnorePatterns: ["<rootDir>/.next/", "<rootDir>/node_modules/"],
+};
+
+module.exports = createJestConfig(customJestConfig);

frontend/lib/nicknames.ts

@@ -90,7 +90,6 @@ export async function generateUniqueNickname(
     }
 
     // If not unique, try again (this is rare but possible)
-    // eslint-disable-next-line no-console
     console.log(`Nickname collision: ${nickname}, retrying... (attempt ${attempt + 1}/${maxAttempts})`);
   }