Feedback

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,62 @@
+name: "🐞 Bug Report"
+description: "Report a bug to help us improve the project"
+title: "[BUG] :"
+labels: [bug]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### 🐞 Thanks for taking the time to report a bug!  
+        Please provide the following details to help us resolve the issue.  
+        _(Fields marked with a `*` are required)_
+
+  - type: input
+    id: bug_title
+    attributes:
+      label: "⚠️ Bug Summary"
+      description: "Briefly describe the bug. *"
+      placeholder: "e.g. App crashes on launch"
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction_steps
+    attributes:
+      label: "🧩 Steps to Reproduce"
+      description: "Steps to reproduce the behavior. *"
+      placeholder: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: "✅ Expected behavior"
+      description: "Describe what you expected to happen. *"
+      placeholder: "e.g. The app should load the dashboard screen."
+
+  - type: textarea
+    id: actual_behavior
+    attributes:
+      label: "❌ Actual behavior"
+      description: "Describe what actually happens when the bug occurs. *"
+      placeholder: "e.g. The app crashes and closes immediately."
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: "📸 Screenshots"
+      description: "If applicable, add screenshots to help explain the problem."
+      placeholder: "Optional"
+
+  - type: input
+    id: environment_info
+    attributes:
+      label: "💻 Environment Details"
+      description: "Please provide details about your environment (OS, Browser, Version, etc.). *"
+      placeholder: "e.g. Windows 10, Chrome 92"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,37 @@
+name: 🚀 Feature Request
+description: Suggest a feature or enhancement for the project
+title: "[FEATURE] "
+labels: [enhancement]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        🚀 Thanks for submitting a feature request! Please answer the following questions to help us better understand your request.
+
+  - type: input
+    id: feature_name
+    attributes:
+      label: "🎯 Feature Name"
+      description: "Provide a brief name for the feature request."
+      placeholder: "e.g. Dark Mode Toggle"
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem_statement
+    attributes:
+      label: "🛠️ Problem Statement"
+      description: "Describe the problem or challenge that this feature would solve."
+      placeholder: "What is the current situation or problem that this feature would address?"
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution_description
+    attributes:
+      label: "💡 Describe the solution you'd like"
+      description: "Give a clear and concise description of what you want to happen."
+      placeholder: "e.g. Adding a dark mode toggle to the settings menu."
+    validations:
+      required: true

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Context
+
+> Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+## Changes
+
+> Please list your changes here. For example:
+>- Add new tests
+
+## Screenshot (if applicated)
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

.github/workflows/cd.yml

@@ -0,0 +1,23 @@
+name: CD Pipeline
+
+on:
+  push:
+    branches:
+      - releases/*
+  pull_request:
+    branches:
+      - releases/*
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Log in to Docker Hub
+        run: echo "${{ secrets.DOCKER_HUB_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_HUB_USERNAME }}" --password-stdin
+
+      - name: Build, Tag, Push Docker image
+        run: bash docker_auto_push.sh

.github/workflows/ci_be.yml

@@ -0,0 +1,75 @@
+name: CI for BE
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - 'be_repo/**'
+
+permissions:
+  contents: write
+  checks: write
+  pull-requests: write
+
+jobs:
+  live-test:
+    name: Live Test
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./be_repo
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-cov
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      - name: Build coverage file
+        run: |
+          pytest --ignore=tests/test_e2e.py --junitxml=pytest.xml \
+                 --cov=app --cov=modules \
+                 --cov-report=term-missing:skip-covered tests/ | tee pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        id: coverageComment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./be_repo/pytest-coverage.txt
+          junitxml-path: ./be_repo/pytest.xml
+
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Update Readme with Coverage Html
+        run: |
+          sed -i '/<!-- Pytest Coverage Comment:Begin -->/,/<!-- Pytest Coverage Comment:End -->/c\<!-- Pytest Coverage Comment:Begin -->\n\${{ steps.coverageComment.outputs.coverageHtml }}\n<!-- Pytest Coverage Comment:End -->' ../README.md
+
+      - name: Debug current branch
+        run: |
+          echo "head ref: ${{ github.head_ref }} "
+          echo "ref name: ${{ github.ref_name }} "
+
+      - name: Commit & Push changes to Readme
+        uses: ad-m/github-push-action@master
+        with:
+          branch: ${{ github.head_ref || github.ref_name }}
+          message: Update coverage on Readme
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci_e2e.yml

@@ -0,0 +1,79 @@
+name: CI for E2E
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  e2e-test:
+    runs-on: ubuntu-latest
+
+    services:
+      frontend:
+        image: node:18
+        options: --network-alias frontend
+        env:
+          PORT: 3000
+        ports:
+          - 3000:3000
+
+      backend:
+        image: python:3.9
+        options: --network-alias backend
+        env:
+          PORT: 5000
+        ports:
+          - 5000:5000
+
+
+    steps:
+      # Step 1: Checkout code
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Start FE
+      - name: Set up and start frontend
+        working-directory: ./fe_repo
+        run: |
+          npm install -g pnpm
+          pnpm i
+          pnpm lint
+          pnpm build
+          pnpm preview &
+
+      # Step 3: Start BE
+      - name: Set up and start backend
+        working-directory: ./be_repo
+        run: |
+          pip install -r requirements.txt
+          python app.py &
+
+      # Step 4: Wair for BE and FE Services
+      - name: Wait for services to be ready
+        run: |
+          until curl -s http://localhost:8081; do
+            echo "Waiting for frontend to be ready..."
+            sleep 5
+          done
+
+          until curl -s http://localhost:5000; do
+            echo "Waiting for backend to be ready..."
+            sleep 5
+          done
+
+      # Step 5: Start E2E Test
+      - name: Installing package list
+        run: apt list --installed
+      - name: Removing previous chrome instances on runner
+        run: sudo apt purge google-chrome-stable
+
+      - name: Installing all necessary packages
+        run: pip install chromedriver-autoinstaller selenium pyvirtualdisplay pytest
+      - name: Install xvfb
+        run: sudo apt-get install xvfb
+
+
+      - name: Run E2E tests
+        run: |
+          pytest ./be_repo/tests/test_e2e.py

.github/workflows/ci_fe.yml

@@ -0,0 +1,53 @@
+name: CI for FE
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - fe_repo/*
+
+jobs:
+  "build-test-linter":
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./fe_repo
+
+    services:
+      docker:
+        image: docker:20.10.16
+        options: --privileged
+
+    steps:
+      # Step 1: Check out the repository
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Step 2: Set up Node.js environment
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "22"
+
+      # Step 3: Install dependencies
+      - name: Install dependencies
+        run: |
+          npm install -g pnpm
+          pnpm i
+
+      # Step 4: Linter
+      - name: Check the linter
+        run: |
+          pnpm lint
+
+      # Step 5: Run Vite tests
+      - name: Run Vite tests
+        run: |
+          pnpm coverage
+
+      # Step 6: Build the project with Vite
+      - name: Build the project
+        run: |
+          pnpm build

.github/workflows/deploy_to_ec2.yml

@@ -0,0 +1,29 @@
+name: Deploy to EC2
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install SSH Key
+        uses: webfactory/ssh-agent@v0.9.0
+        with:
+          ssh-private-key: ${{ secrets.EC2_SSH_KEY }}
+
+      # stop old service and start a new one
+      - name: Deploy to EC2
+        run: |
+          ssh -o StrictHostKeyChecking=no adamma2048@${{ secrets.EC2_IP }} << EOF
+          cd seprojects-cs673a2f24_team5
+          sudo bash docker_auto_start.sh stop
+          git switch main
+          git pull
+          sudo bash docker_auto_start.sh start
+          EOF

.gitignore

@@ -0,0 +1,7 @@
+/.idea/
+node_modules
+package-lock.json
+.DS_Store
+.vite
+/code/configs/config.json
+__pycache__