Merge pull request #52 from dat515-2025/51-refactor-project-structure

feat(docs): codebase refactor - added src directory

.github/workflows/build-image.yaml

@@ -15,7 +15,7 @@ on:
       context:
         description: "Docker build context path"
         required: false
-        default: "7project/backend"
+        default: "7project/src/backend"
         type: string
       pr_number:
         description: "PR number (required when mode=pr)"

.github/workflows/deploy-pr.yaml

@@ -21,7 +21,7 @@ jobs:
     with:
       mode: pr
       image_repo: lukastrkan/cc-app-demo
-      context: 7project/backend
+      context: 7project/src/backend
       pr_number: ${{ github.event.pull_request.number }}
     secrets: inherit
 
@@ -90,9 +90,9 @@ jobs:
           PR=${{ github.event.pull_request.number }}
           RELEASE=myapp-pr-$PR
           NAMESPACE=pr-$PR
-          helm upgrade --install "$RELEASE" ./7project/charts/myapp-chart \
+          helm upgrade --install "$RELEASE" ./7project/src/charts/myapp-chart \
             -n "$NAMESPACE" --create-namespace \
-            -f 7project/charts/myapp-chart/values-dev.yaml \
+            -f 7project/src/charts/myapp-chart/values-dev.yaml \
             --set prNumber="$PR" \
             --set deployment="pr-$PR" \
             --set domain="$DOMAIN" \

.github/workflows/deploy-prod.yaml

@@ -4,9 +4,9 @@ on:
   push:
     branches: [ "main" ]
     paths:
-      - 7project/backend/**
+      - ../../7project/src/backend/**
-      - 7project/frontend/**
+      - ../../7project/src/frontend/**
-      - 7project/charts/myapp-chart/**
+      - ../../7project/src/charts/myapp-chart/**
       - .github/workflows/deploy-prod.yaml
       - .github/workflows/build-image.yaml
       - .github/workflows/frontend-pages.yml
@@ -32,7 +32,7 @@ jobs:
     with:
       mode: prod
       image_repo: lukastrkan/cc-app-demo
-      context: 7project/backend
+      context: 7project/src/backend
     secrets: inherit
 
   get_urls:
@@ -103,9 +103,9 @@ jobs:
           SMTP_FROM: ${{ secrets.SMTP_FROM }}
           UNIRATE_API_KEY: ${{ secrets.UNIRATE_API_KEY }}
         run: |
-          helm upgrade --install myapp ./7project/charts/myapp-chart \
+          helm upgrade --install myapp ./7project/src/charts/myapp-chart \
             -n prod --create-namespace \
-            -f 7project/charts/myapp-chart/values-prod.yaml \
+            -f 7project/src/charts/myapp-chart/values-prod.yaml \
             --set deployment="prod" \
             --set domain="$DOMAIN" \
             --set domain_scheme="$DOMAIN_SCHEME" \

.github/workflows/frontend-pages.yml

@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: 7project/frontend
+        working-directory: 7project/src/frontend
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -45,7 +45,7 @@ jobs:
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: 7project/frontend/package-lock.json
+          cache-dependency-path: 7project/src/frontend/package-lock.json
 
       - name: Install dependencies
         run: npm ci
@@ -61,7 +61,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: frontend-dist
-          path: 7project/frontend/dist
+          path: 7project/src/frontend/dist
 
   deploy:
     name: Deploy to Cloudflare Pages

.github/workflows/run-tests.yml

@@ -46,21 +46,21 @@ jobs:
 
       - name: Add test dependencies to requirements
         run: |
-          echo "pytest==8.4.2" >> ./7project/backend/requirements.txt
+          echo "pytest==8.4.2" >> ./7project/src/backend/requirements.txt
-          echo "pytest-asyncio==1.2.0" >> ./7project/backend/requirements.txt
+          echo "pytest-asyncio==1.2.0" >> ./7project/src/backend/requirements.txt
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r ./7project/backend/requirements.txt
+          pip install -r ./7project/src/backend/requirements.txt
 
       - name: Run Alembic migrations
         run: |
           alembic upgrade head
-        working-directory: ./7project/backend
+        working-directory: ./7project/src/backend
 
       - name: Run tests with pytest
         env:
           PYTEST_RUN_CONFIG: "True"
         run: pytest
-        working-directory: ./7project/backend
+        working-directory: ./7project/src/backend

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

7project/.gitignore

@@ -1,8 +1,8 @@
-/tofu/controlplane.yaml
+/src/tofu/controlplane.yaml
-/tofu/kubeconfig
+/src/tofu/kubeconfig
-/tofu/talosconfig
+/src/tofu/talosconfig
-/tofu/terraform.tfstate
+/src/tofu/terraform.tfstate
-/tofu/terraform.tfstate.backup
+/src/tofu/terraform.tfstate.backup
-/tofu/worker.yaml
+/src/tofu/worker.yaml
-/tofu/.terraform.lock.hcl
+/src/tofu/.terraform.lock.hcl
-/tofu/.terraform/
+/src/tofu/.terraform/

7project/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

7project/report.md

@@ -166,7 +166,7 @@ You can run the project with Docker Compose and Python virtual environment for t
 
 ```bash
 git clone https://github.com/dat515-2025/Group-8.git
-cd Group-8/7project
+cd Group-8/7project/src
 ```
 
 ### 2) Install dependencies
@@ -423,8 +423,8 @@ The tests are located in 7project/backend/tests directory. All tests are run by
 push to main.
 See the workflow [here](../.github/workflows/run-tests.yml).
 
-If you want to run the tests locally, the preferred way is to use a [bash script](backend/test_locally.sh)
+If you want to run the tests locally, the preferred way is to use a [bash script](src/backend/test_locally.sh)
-that will start a test DB container with [docker compose](backend/docker-compose.test.yml)  and remove it afterwards.
+that will start a test DB container with [docker compose](src/backend/docker-compose.test.yml)  and remove it afterwards.
 ```bash
 cd 7project/backend 
 bash test_locally.sh
@@ -432,7 +432,7 @@ bash test_locally.sh
 
 ### Unit Tests
 
-There are only 5 basic unit tests, since our services logic is very simple
+There are 5 basic unit tests, since our services logic is very simple
 
 ```bash
 bash test_locally.sh --only-unit
@@ -584,7 +584,7 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 | 25.9.           | Design                   | 2      | 6design                                                       |                                                          |
 | 9.10 to 11.10.  | Backend APIs             | 14     | Implemented Backend APIs                                      | `PR #26`, `20-create-a-controller-layer-on-backend-side` |
 | 13.10 to 15.10. | Frontend Development     | 8      | Created user interface mockups                                | `PR #28`, `frontend basics`                              |
-| Continually     | Documentation            | 7      | Documenting the dev process                                   |                                                          |
+| Continually     | Documentation            | 8      | Documenting the dev process                                   |                                                          |
 | 21.10 to 23.10  | Tests, frontend          | 10     | Test basics, balance charts, and frontend improvement         | `PR #31`, `30 create tests and set up a GitHub pipeline` |
 | 28.10 to 30.10  | CI                       | 6      | Integrated tests with test database setup on github workflows | `PR #28`, `frontend basics`                              |
 | 28.10 to 30.10  | Frontend                 | 8      | UI improvements and exchange rate API integration             | `PR #28`, `frontend basics`                              |
@@ -594,7 +594,7 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 | 11.11 to 12.11  | Tests                    | 3      | Local testing DB container, few fixes                         | `PR #28`, `frontend basics`                              |
 | 12.11           | Frontend                 | 3      | Enabled multiple transaction edits at once, CSAS button state | `PR #28`, `frontend basics`                              |
 | 13.11           | Video                    | 3      | Video                                                         |                                                          |
-| **Total**       |                          | **80** |                                                               |                                                          |
+| **Total**       |                          | **81** |                                                               |                                                          |
 
 ### Group Total: [XXX.X] hours
 

7project/src/backend/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml