Merge pull request #141 from AntonioMrtz/docs/Project-Documentation

Add Mkdocs Project Documentation

.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: ""
 ---
 
 ## Description

.github/disabled_workflows/backend-black.yml

@@ -3,8 +3,8 @@ name: Backend Run Black style
 on:
   pull_request:
     branches:
-      - 'master'
-      - 'master-*'
+      - "master"
+      - "master-*"
 
 jobs:
   run_tests:

.github/disabled_workflows/enforce-branch-name.yml

@@ -3,29 +3,29 @@ name: Enforce Branch Naming
 on:
   create:
     branches:
-      - '*'
+      - "*"
 
 jobs:
   enforce-branch-naming:
     permissions: write-all
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    - name: Check branch name format
-      id: check_branch
-      run: |
-        branch_name=$(echo "${GITHUB_REF#refs/heads/}")
-        if [[ ! "$branch_name" =~ (^(feat|fix|refactor|docs|chore|test|style|build|ci|perf|revert)\/.*)|(master\-.*)|(dependabot\-.*) ]]; then
-          echo "Branch name doesn't match the required format."
-          exit 1
-        fi
+      - name: Check branch name format
+        id: check_branch
+        run: |
+          branch_name=$(echo "${GITHUB_REF#refs/heads/}")
+          if [[ ! "$branch_name" =~ (^(feat|fix|refactor|docs|chore|test|style|build|ci|perf|revert)\/.*)|(master\-.*)|(dependabot\-.*) ]]; then
+            echo "Branch name doesn't match the required format."
+            exit 1
+          fi
 
-    - name: Delete branch if fail
-      if: ${{ failure() }}
-      uses: dawidd6/action-delete-branch@v3
-      with:
-        github_token: ${{github.token}}
-        branches: ${{ github.ref_name }}
+      - name: Delete branch if fail
+        if: ${{ failure() }}
+        uses: dawidd6/action-delete-branch@v3
+        with:
+          github_token: ${{github.token}}
+          branches: ${{ github.ref_name }}

.github/disabled_workflows/generate-docs.yml

@@ -11,41 +11,41 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout del repositorio
-      uses: actions/checkout@v2
-      with:
-        persist-credentials: false
-        token: ${{ secrets.PAT }}
+      - name: Checkout del repositorio
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          token: ${{ secrets.PAT }}
 
-    - name: Configurar Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.11
+      - name: Configurar Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
 
-    - name: Install dependencies
-      working-directory: Backend/
-      run: |
-        python -m venv venv
-        source venv/bin/activate
-        pip install -r requirements.txt
-        python generate-docs.py
-      env:
-          MONGO_URI : ${{ secrets.MONGO_URI }}
-          SECRET_KEY_SIGN : ${{ secrets.SECRET_KEY_SIGN }}
-          SERVERLESS_FUNCTION_URL : ${{ secrets.SERVERLESS_FUNCTION_URL }}
-          ARCH : ${{ secrets.ARCH }}
-          ENV_VALUE : ${{ secrets.ENV_VALUE }}
+      - name: Install dependencies
+        working-directory: Backend/
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          pip install -r requirements.txt
+          python generate-docs.py
+        env:
+            MONGO_URI : ${{ secrets.MONGO_URI }}
+            SECRET_KEY_SIGN : ${{ secrets.SECRET_KEY_SIGN }}
+            SERVERLESS_FUNCTION_URL : ${{ secrets.SERVERLESS_FUNCTION_URL }}
+            ARCH : ${{ secrets.ARCH }}
+            ENV_VALUE : ${{ secrets.ENV_VALUE }}
 
-    - name: Add and commit changes
-      working-directory: Backend/
-      run: |
-        git config --local user.email "actions@github.com"
-        git config --local user.name "GitHub Actions"
-        git add api-docs-spotify-electron.html
-        git commit -m "docs : Update API documentation"
+      - name: Add and commit changes
+        working-directory: Backend/
+        run: |
+          git config --local user.email "actions@github.com"
+          git config --local user.name "GitHub Actions"
+          git add api-docs-spotify-electron.html
+          git commit -m "docs : Update API documentation"
 
-    - name: Pushing to the protected branch 'protected'
-      uses: CasperWA/push-protected@v2
-      with:
-        token: ${{ secrets.PAT }}
-        branch: ${{ github.base_ref }}
+      - name: Pushing to the protected branch 'protected'
+        uses: CasperWA/push-protected@v2
+        with:
+          token: ${{ secrets.PAT }}
+          branch: ${{ github.base_ref }}

.github/pull_request_template.md

@@ -45,6 +45,7 @@
 ## Tests Performed
 
 - [] Test performed <!-- Check if performed  - [✅ | ❎] Test performed -->
+
 ## Screenshots
 
 <!-- If applicable, provide screenshots that help visualize the changes made. -->

.github/workflows/eslintrc-check.yml

@@ -3,24 +3,24 @@ name: Eslintrc Check
 on:
   pull_request:
     branches:
-      - 'master'
-      - 'master-*'
+      - "master"
+      - "master-*"
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Set up Node.js
-      uses: actions/setup-node@v2
-      with:
-        node-version: '20'
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "20"
 
-    - name: Change directory and run commands
-      working-directory: Electron
-      run: |
-        npm install
-        npm run lint
+      - name: Change directory and run commands
+        working-directory: Electron
+        run: |
+          npm install
+          npm run lint

.github/workflows/frontend-style-prettier.yml

@@ -3,24 +3,24 @@ name: Frontend Style Prettier
 on:
   pull_request:
     branches:
-      - 'master'
-      - 'master-*'
+      - "master"
+      - "master-*"
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Check out code
-      uses: actions/checkout@v2
+      - name: Check out code
+        uses: actions/checkout@v2
 
-    - name: Set up Node.js
-      uses: actions/setup-node@v2
-      with:
-        node-version: '20'
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "20"
 
-    - name: Change directory and run commands
-      working-directory: Electron
-      run: |
-        npm install
-        npm run format:check
+      - name: Change directory and run commands
+        working-directory: Electron
+        run: |
+          npm install
+          npm run format:check

.github/workflows/frontend-tests.yml

@@ -3,25 +3,25 @@ name: Frontend Tests
 on:
   pull_request:
     branches:
-      - 'master'
-      - 'master-*'
+      - "master"
+      - "master-*"
 
 jobs:
   build:
     runs-on: ubuntu-22.04
 
     steps:
-    - name: Check out code
-      uses: actions/checkout@v4
+      - name: Check out code
+        uses: actions/checkout@v4
 
-    - name: Set up Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20'
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
 
-    - name: Change directory and run commands
-      working-directory: Electron
-      run: |
-        npm install
-        npm run build
-        npm test
+      - name: Change directory and run commands
+        working-directory: Electron
+        run: |
+          npm install
+          npm run build
+          npm test

.github/workflows/generate-docs.yml

@@ -0,0 +1,29 @@
+name: Generate Docs
+
+on:
+  pull_request:
+    types: [closed]
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements-docs.txt
+      - run: mkdocs gh-deploy --force