Initial files for auto cd/ci

.github/workflows/ci-backend.yaml

@@ -0,0 +1,66 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: CI Backend
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+      - 'feature/**'
+      - 'Feature/**'
+      - 'fix/*'
+      - 'Fix/*'
+      - 'ofmcc-*'
+    paths:
+      - 'backend/src/**'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'backend/src/**'
+
+jobs:
+  test:
+    name: Run ESLint
+    runs-on: ubuntu-24.04
+    defaults:
+      run:
+        working-directory: backend
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.16.x'
+      - run: npm ci
+      - run: npm run lint
+        env:
+          NODE_ENV: 'test'
+
+  # TODO: Uncomment after project is set up in sonar
+  # sonarcloud:
+  #   name: Build (Sonar Cloud)
+  #   runs-on: ubuntu-24.04
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #       with:
+  #         # Disabling shallow clone is recommended for improving relevancy of reporting
+  #         fetch-depth: 0
+  #     - uses: actions/setup-node@v3
+  #       with:
+  #         node-version: '14.x'
+  #     - name: SonarCloud Scan
+  #       uses: sonarsource/sonarcloud-github-action@master
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+  #with:
+  #args: >
+  #-Dsonar.exclusions=**/test/**,.github/**/*,*.md
+  #-Dsonar.organization=bcgov-sonarcloud
+  #-Dsonar.javascript.lcov.reportPaths=backend/coverage/lcov.info
+  #-Dsonar.project.monorepo.enabled=true
+  #-Dsonar.projectKey=${{ github.event.repository.name }}
+  #-Dsonar.sources=backend
+  #-Dsonar.tests=backend/tests

.github/workflows/ci-frontend.yaml

@@ -0,0 +1,66 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: CI Frontend
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - 'feature/**'
+      - 'Feature/**'
+      - 'fix/*'
+      - 'Fix/*'
+      - 'ofmcc-*'
+    paths:
+      - 'frontend/src/**'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'frontend/src/**'
+      - 'frontend/src/**'
+
+jobs:
+  test:
+    name: Run ESLint
+    runs-on: ubuntu-24.04
+
+    defaults:
+      run:
+        working-directory: frontend
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.16.x'
+      - run: npm ci
+      - run: npm run lint
+
+  # TODO: Uncomment after project is set up in sonar
+  # sonarcloud:
+  #   name: Build (Sonar Cloud)
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #       with:
+  #         # Disabling shallow clone is recommended for improving relevancy of reporting
+  #         fetch-depth: 0
+  #     - uses: actions/setup-node@v3
+  #       with:
+  #         node-version: '14.x'
+  #     - name: SonarCloud Scan
+  #       uses: sonarsource/sonarcloud-github-action@master
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+  #with:
+  #args: >
+  #-Dsonar.exclusions=**/test/**,.github/**/*,*.md
+  #-Dsonar.organization=bcgov-sonarcloud
+  #-Dsonar.javascript.lcov.reportPaths=frontend/coverage/lcov.info
+  #-Dsonar.project.monorepo.enabled=true
+  #-Dsonar.projectKey=${{ github.event.repository.name }}
+  #-Dsonar.sources=frontend
+  #-Dsonar.tests=frontend/tests

backend/README.md

@@ -17,6 +17,20 @@ This project was built using the EDUC-CCOF project as a template.
 
 **`Step 6`** Open http://localhost:8080/api/health to verify that the app is running.
 
+### Lint with [ESLint](https://eslint.org/)
+
+With NPM:
+
+```sh
+npm run lint
+```
+
+To fix issues:
+
+```sh
+npm run lint:fix
+```
+
 ### Unit Tests
 
 Run `npm run test` in command line from backend folder, to execute unit tests.

backend/eslint.config.mjs

@@ -0,0 +1,29 @@
+import js from '@eslint/js'
+import eslintPluginPrettier from 'eslint-plugin-prettier/recommended'
+
+const globals = import('globals')
+
+export default [
+  js.configs.recommended,
+  eslintPluginPrettier,
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      sourceType: 'commonjs',
+      globals: {
+        // This doesn't seem to be working as expected hence the user-defined globals
+        ...globals.node,
+        __dirname: 'readonly',
+        process: 'readonly',
+        setTimeout: 'readonly',
+      },
+    },
+    rules: {
+      semi: 'off',
+      'eol-last': ['error', 'always'],
+      indent: ['error', 2, { SwitchCase: 1 }],
+      quotes: ['error', 'single', { avoidEscape: true }],
+      'no-unused-vars': ['error', { args: 'after-used', argsIgnorePattern: '^_', caughtErrors: 'all', caughtErrorsIgnorePattern: '^ignore' }],
+    },
+  },
+]