Merge pull request #43 from NUS-Fintech-Society/feature/TAS-13-Layout

Feature/tas 13 layout

.eslintrc.cjs

@@ -2,31 +2,31 @@ module.exports = {
   root: true,
   env: { browser: true, es2020: true },
   extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:react/recommended',
-    'plugin:react-hooks/recommended',
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
   ],
-  ignorePatterns: ['dist', '.eslintrc.cjs'],
-  parser: '@typescript-eslint/parser',
+  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 2021,
-    sourceType: 'module',
+    sourceType: "module",
     ecmaFeatures: {
       jsx: true,
     },
   },
-  plugins: ['react-refresh', '@typescript-eslint', 'react', 'react-hooks'],
+  plugins: ["react-refresh", "@typescript-eslint", "react", "react-hooks"],
   rules: {
     "react/react-in-jsx-scope": "off",
-    'react-refresh/only-export-components': [
-      'warn',
+    "react-refresh/only-export-components": [
+      "warn",
       { allowConstantExport: true },
     ],
   },
   settings: {
     react: {
-      version: 'detect',
+      version: "detect",
     },
   },
-}
+};

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/pull_request_template.md

@@ -1,12 +1,15 @@
 # Pull Request
 
 ## Description
+
 [Provide a brief description of the changes in this pull request.]
 
 ## Related Issues
+
 [Reference any related issues that this pull request addresses or resolves.]
 
 ## Checklist
+
 Please review and check the following before submitting your pull request:
 
 - [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) document.
@@ -17,15 +20,17 @@ Please review and check the following before submitting your pull request:
 - [ ] I have added comments to my code, particularly in areas that may be confusing.
 
 ## Screenshots (if applicable)
+
 [Include any relevant screenshots or GIFs to visually demonstrate the changes.]
 
 ### Desktop
 
 ### Mobile
 
 ## Additional Information
+
 [Include any additional information that might be helpful for reviewers or maintainers.]
 
 ## Reviewer Notes
-[Optional: Include specific instructions or notes for reviewers, if necessary.]
 
+[Optional: Include specific instructions or notes for reviewers, if necessary.]

.github/workflows/autoupdate.yml

@@ -2,9 +2,9 @@ name: autoupdate
 on:
   # This will trigger on all pushes to all branches.
   push:
-  # Alternatively, you can only trigger if commits are pushed to certain branches, e.g.:
-   branches:
-     - main
+    # Alternatively, you can only trigger if commits are pushed to certain branches, e.g.:
+    branches:
+      - main
 
 jobs:
   autoupdate:
@@ -13,6 +13,6 @@ jobs:
     steps:
       - uses: docker://chinthakagodawita/autoupdate-action:v1
         env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           PR_FILTER: "labelled"
           PR_LABELS: "epic"

.github/workflows/test.yml

@@ -22,10 +22,10 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'yarn'
+          cache: "yarn"
 
       - name: Install dependencies
         run: yarn
 
       - name: Run Vitest
-        run: yarn vitest
+        run: yarn vitest

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

.prettierrc

@@ -0,0 +1 @@
+{}

README.md

@@ -5,20 +5,21 @@ This template provides a minimal setup to get React working in Vite with HMR and
 ## Setup Guide
 
 This project was set up with NodeJS v20.11.0 LTS with yarn.
+
 1. Install packages
-    ```shell
-    yarn
-    ```
+   ```shell
+   yarn
+   ```
 2. Create a file `.env.development.local` in root folder with the following information
    ```text
    VITE_IGNORE_MSW=false
    ```
    If you would like to ignore mock service worker, set it to `true`.
 3. Create another file `.env.test.local` in root folder with same content as above
 4. Run the development server
-    ```shell
-    yarn dev
-    ```
+   ```shell
+   yarn dev
+   ```
 
 ## Dependencies
 
@@ -47,12 +48,12 @@ If you are developing a production application, we recommend updating the config
 export default {
   // other rules...
   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
+    ecmaVersion: "latest",
+    sourceType: "module",
+    project: ["./tsconfig.json", "./tsconfig.node.json"],
     tsconfigRootDir: __dirname,
   },
-}
+};
 ```
 
 - Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`

package.json

@@ -39,6 +39,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.5",
     "jsdom": "^24.0.0",
+    "prettier": "3.2.5",
     "tsc-alias": "^1.8.8",
     "typescript": "^5.4.2",
     "vite": "^5.0.8",