Merge pull request #9 from CS3219-AY2526Sem1/setup-github-workflows

Setup GitHub workflows

Author: NorbertLoh

.github/workflows/commit-workflow.yml

@@ -0,0 +1,22 @@
+name: Commit workflow
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [20.x]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        working-directory: ./frontend/peerprep
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build

frontend/peerprep/Dockerfile

@@ -1,6 +1,6 @@
 FROM node:20-alpine AS development-dependencies-env
-COPY . /app
 WORKDIR /app
+COPY package*.json ./
 RUN npm ci
 
 FROM node:20-alpine AS production-dependencies-env
@@ -20,4 +20,4 @@ COPY --from=production-dependencies-env /app/node_modules /app/node_modules
 COPY --from=build-env /app/build /app/build
 WORKDIR /app
 EXPOSE 3000
-CMD ["npm", "run", "start"]
+CMD ["npm",  "start"]

frontend/peerprep/README.md

@@ -78,6 +78,13 @@ Make sure to deploy the output of `npm run build`
 │   └── server/    # Server-side code
 ```
 
+### Lint check
+To run the lint check:
+
+```bash
+npm run lint
+```
+
 ## Styling
 
 This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.

frontend/peerprep/app/routes/home.tsx

@@ -1,7 +1,6 @@
-import type { Route } from "./+types/home";
 import { Welcome } from "../welcome/welcome";
 
-export function meta({}: Route.MetaArgs) {
+export function meta() {
   return [
     { title: "New React Router App" },
     { name: "description", content: "Welcome to React Router!" },

frontend/peerprep/eslint.config.js

@@ -0,0 +1,32 @@
+// Setup guide from : https://eslint-react.xyz/docs/getting-started/typescript
+
+// @ts-check
+import eslintJs from "@eslint/js";
+import eslintReact from "@eslint-react/eslint-plugin";
+import tseslint from "typescript-eslint";
+export default tseslint.config({
+  files: ["**/*.ts", "**/*.tsx"],
+  // Extend recommended rule sets from:
+  // 1. ESLint JS's recommended rules
+  // 2. TypeScript ESLint recommended rules
+  // 3. ESLint React's recommended-typescript rules
+  extends: [
+    eslintJs.configs.recommended,
+    tseslint.configs.recommended,
+    eslintReact.configs["recommended-typescript"],
+  ],
+  // Configure language/parsing options
+  languageOptions: {
+    // Use TypeScript ESLint parser for TypeScript files
+    parser: tseslint.parser,
+    parserOptions: {
+      // Enable project service for better TypeScript integration
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+  // Custom rule overrides (modify rule levels or disable rules)
+  rules: {
+    "@eslint-react/no-missing-key": "warn",
+  },
+});