Merge Development branch to Main branch

.dockerignore

@@ -0,0 +1,7 @@
+Dockerfile
+.dockerignore
+node_modules
+npm-debug.log
+README.md
+.next
+.git

.eslintignore

@@ -1,7 +1,8 @@
-vite.config.ts
+codegen.ts
 node_modules/**
 coverage/**
 src/assets/**
+src/__generated__/**
 .eslintrc
 /dist
 

.eslintrc

@@ -5,6 +5,7 @@
     "es2020": true
   },
   "extends": [
+    "next/core-web-vitals",
     "eslint:recommended",
     "prettier",
     "plugin:react/recommended",
@@ -102,12 +103,72 @@
           },
           {
             "group": "external",
+            "pattern": "@/pages/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/features/**/*.tsx",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/components/**/*.tsx",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/**/*.tsx",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/features/**/*.ts",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/components/**/*.ts",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/hooks/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/utils/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/queries/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/constants/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/assets/**",
+            "position": "after"
+          },
+          {
+            "group": "external",
+            "pattern": "@/__generated__/**",
+            "position": "after"
+          },
+          {
+            "group": "object",
             "pattern": "./*.svg",
             "position": "after"
           },
           {
-            "pattern": "./*.css",
-            "group": "sibling",
+            "pattern": "./*.scss",
+            "group": "object",
             "position": "after"
           }
         ],
@@ -170,12 +231,12 @@
     "react/destructuring-assignment": "warn",
     "react/forbid-prop-types": "error",
     "react/prop-types": "error",
-    "react/button-has-type": "warn",
     "react-hooks/rules-of-hooks": "error",
     "react-hooks/exhaustive-deps": "error",
     "@typescript-eslint/no-var-requires": "warn",
     "@typescript-eslint/no-duplicate-enum-values": "warn",
     "@typescript-eslint/no-empty-function": "warn",
+    "@typescript-eslint/no-shadow": "warn",
     // can be replaced by noop from lodash
     "@typescript-eslint/no-unused-vars": [
       "warn",
@@ -222,14 +283,21 @@
     "no-await-in-loop": "warn",
     "no-plusplus": "warn",
     "no-bitwise": "warn",
-    "no-shadow": "warn",
+    "no-shadow": "off",
     "no-restricted-syntax": "warn",
     "no-restricted-exports": "warn",
     "no-use-before-define": "warn",
     "no-nested-ternary": "error",
     "no-param-reassign": "warn",
     "no-mixed-operators": "warn",
-    "no-underscore-dangle": "warn",
+    "no-underscore-dangle": [
+      "warn",
+      {
+        "allow": [
+          "__typename"
+        ]
+      }
+    ],
     "max-len": "off",
     "default-case": "off",
     "key-spacing": "off",

.github/workflows/deploy-cloud-run-source-prod.yml

@@ -0,0 +1,89 @@
+# This workflow will deploy source code on Cloud Run when a commit is pushed to the $default-branch branch
+#
+# Overview:
+#
+# 1. Authenticate to Google Cloud
+# 2. Deploy it to Cloud Run
+#
+# To configure this workflow:
+#
+# 1. Ensure the required Google Cloud APIs are enabled:
+#
+#    Cloud Run            run.googleapis.com
+#    Cloud Build          cloudbuild.googleapis.com
+#    Artifact Registry    artifactregistry.googleapis.com
+#
+# 2. Create and configure Workload Identity Federation for GitHub (https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)
+#
+# 3. Ensure the required IAM permissions are granted
+#
+#    Cloud Run
+#      roles/run.admin
+#      roles/iam.serviceAccountUser     (to act as the Cloud Run runtime service account)
+#
+#    Cloud Build
+#      roles/cloudbuild.builds.editor
+#
+#    Cloud Storage
+#      roles/storage.admin
+#
+#    Artifact Registry
+#      roles/artifactregistry.admin     (project or repository level)
+#
+#    NOTE: You should always follow the principle of least privilege when assigning IAM roles
+#
+# 4. Create GitHub secrets for WIF_PROVIDER and WIF_SERVICE_ACCOUNT
+#
+# 5. Change the values for the SERVICE and REGION environment variables (below).
+#
+# For more support on how to run this workflow, please visit https://github.com/marketplace/actions/deploy-to-cloud-run
+#
+# Further reading:
+#   Cloud Run runtime service account   - https://cloud.google.com/run/docs/securing/service-identity
+#   Cloud Run IAM permissions           - https://cloud.google.com/run/docs/deploying-source-code#permissions_required_to_deploy
+#   Cloud Run builds from source        - https://cloud.google.com/run/docs/deploying-source-code
+#   Principle of least privilege        - https://cloud.google.com/blog/products/identity-security/dont-get-pwned-practicing-the-principle-of-least-privilege
+
+name: Deploy to Cloud Run PROD ENV
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  PROJECT_ID: cdkz-frontend # TODO: update Google Cloud project id
+  SERVICE: epmgcip-connect-ed-ui # TODO: update Cloud Run service name
+  REGION: us-central1 # TODO: update Cloud Run service region
+
+jobs:
+  deploy:
+    # Add 'id-token' with the intended permissions for workload identity federation
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # NOTE: Alternative option - authentication via credentials json
+      - name: Google Auth
+        id: auth
+        uses: 'google-github-actions/auth@v2'
+        with:
+          credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
+
+      - name: Deploy to Cloud Run
+        id: deploy
+        uses: google-github-actions/deploy-cloudrun@v2
+        with:
+          service: ${{ env.SERVICE }}
+          region: ${{ env.REGION }}
+          # NOTE: If required, update to the appropriate source folder
+          source: ./
+
+      # If required, use the Cloud Run url output in later steps
+      - name: Show Output
+        run: echo ${{ steps.deploy.outputs.url }}

.github/workflows/deploy-cloud-run-source-staging.yml

@@ -0,0 +1,89 @@
+# This workflow will deploy source code on Cloud Run when a commit is pushed to the $default-branch branch
+#
+# Overview:
+#
+# 1. Authenticate to Google Cloud
+# 2. Deploy it to Cloud Run
+#
+# To configure this workflow:
+#
+# 1. Ensure the required Google Cloud APIs are enabled:
+#
+#    Cloud Run            run.googleapis.com
+#    Cloud Build          cloudbuild.googleapis.com
+#    Artifact Registry    artifactregistry.googleapis.com
+#
+# 2. Create and configure Workload Identity Federation for GitHub (https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)
+#
+# 3. Ensure the required IAM permissions are granted
+#
+#    Cloud Run
+#      roles/run.admin
+#      roles/iam.serviceAccountUser     (to act as the Cloud Run runtime service account)
+#
+#    Cloud Build
+#      roles/cloudbuild.builds.editor
+#
+#    Cloud Storage
+#      roles/storage.admin
+#
+#    Artifact Registry
+#      roles/artifactregistry.admin     (project or repository level)
+#
+#    NOTE: You should always follow the principle of least privilege when assigning IAM roles
+#
+# 4. Create GitHub secrets for WIF_PROVIDER and WIF_SERVICE_ACCOUNT
+#
+# 5. Change the values for the SERVICE and REGION environment variables (below).
+#
+# For more support on how to run this workflow, please visit https://github.com/marketplace/actions/deploy-to-cloud-run
+#
+# Further reading:
+#   Cloud Run runtime service account   - https://cloud.google.com/run/docs/securing/service-identity
+#   Cloud Run IAM permissions           - https://cloud.google.com/run/docs/deploying-source-code#permissions_required_to_deploy
+#   Cloud Run builds from source        - https://cloud.google.com/run/docs/deploying-source-code
+#   Principle of least privilege        - https://cloud.google.com/blog/products/identity-security/dont-get-pwned-practicing-the-principle-of-least-privilege
+
+name: Deploy to Cloud Run STAGING ENV
+
+on:
+  push:
+    branches:
+      - development
+
+env:
+  PROJECT_ID: cdkz-frontend # TODO: update Google Cloud project id
+  SERVICE: epmgcip-connect-ed-ui # TODO: update Cloud Run service name
+  REGION: us-central1 # TODO: update Cloud Run service region
+
+jobs:
+  deploy:
+    # Add 'id-token' with the intended permissions for workload identity federation
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # NOTE: Alternative option - authentication via credentials json
+      - name: Google Auth
+        id: auth
+        uses: 'google-github-actions/auth@v2'
+        with:
+          credentials_json: '${{ secrets.GCP_CREDENTIALS }}'
+
+      - name: Deploy to Cloud Run
+        id: deploy
+        uses: google-github-actions/deploy-cloudrun@v2
+        with:
+          service: ${{ env.SERVICE }}
+          region: ${{ env.REGION }}
+          # NOTE: If required, update to the appropriate source folder
+          source: ./
+
+      # If required, use the Cloud Run url output in later steps
+      - name: Show Output
+        run: echo ${{ steps.deploy.outputs.url }}

.gitignore

@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+.env
 
 # Editor directories and files
 .vscode/*
@@ -22,3 +23,40 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.lintstagedrc.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  "src/**/*.{js,ts,jsx,tsx}": [
+  "src/!(__generated__)**/*.{js,ts,jsx,tsx}": [
     () => "npm run lint:types",
     "npm run lint -- --fix",
   ],