Feature/admin docs gen

.eslintignore

@@ -1,8 +1,12 @@
 # Contains the PDF file of the Tag as JSON string, thus does not need to be linted
 src/components/CheckIn/tagTemplate.ts
 package.json
 package-lock.json
 tsconfig.json
-
+fix-readme-links.js
+fix-repo-url.js
 # Ignore the Docusaurus website subdirectory
-docs/**
+docs/**
+
+#Ignore markdown files from linting
+*.md

.github/workflows/pull-request.yml

@@ -1,4 +1,4 @@
 ##############################################################################
 ##############################################################################
 #
 # NOTE!
@@ -38,7 +38,7 @@
       - name: Count number of lines
         run: |
           chmod +x ./.github/workflows/scripts/countline.py
-          ./.github/workflows/scripts/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/components/TagActions/TagActionsMocks.ts src/utils/interfaces.ts src/screens/MemberDetail/MemberDetail.tsx
+          ./.github/workflows/scripts/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/components/TagActions/TagActionsMocks.ts src/utils/interfaces.ts src/screens/MemberDetail/MemberDetail.tsx src/components/OrgPostCard/OrgPostCard.tsx /src/components/UsersTableItem/UsersTableItem.tsx
 
       - name: Get changed TypeScript files
         id: changed-files
@@ -204,7 +204,6 @@
         run: |
           python .github/workflows/scripts/eslint_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
-
   Check-Code-Coverage-Disable:
     name: Check for code coverage disable
     runs-on: ubuntu-latest
@@ -303,7 +302,7 @@
         uses: VeryGoodOpenSource/very_good_coverage@v3
         with:
           path: "./coverage/lcov.info"
-          min_coverage: 0.0
+          min_coverage: 0
 
   # Graphql-Inspector:
   #   if: ${{ github.actor != 'dependabot[bot]' }}
@@ -416,27 +415,30 @@
         run: |
           docker stop talawa-admin-app-container
           docker rm talawa-admin-app-container
+
 
   Test-Docusaurus-Deployment:
     name: Test Deployment to https://docs-admin.talawa.io
     runs-on: ubuntu-latest
     needs: [Docker-Start-Check, Start-App-Without-Docker]
-    # Run only if the develop-postgres branch and not dependabot    
+    # Run only if the develop-postgres branch and not dependabot
     if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop-postgres' }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout the Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: '22.x'
-          cache: yarn
-          cache-dependency-path: 'docs/'
-      # Run Docusaurus in the ./docs directory
+          node-version: '20.x' 
+
       - name: Install dependencies
         working-directory: ./docs
-        run: yarn install --frozen-lockfile
+        run: npm install
+
       - name: Test building the website
         working-directory: ./docs
-        run: yarn build
+        run: npm run build
 
   Check-Target-Branch:
     if: ${{ github.actor != 'dependabot[bot]' }}
@@ -449,6 +451,35 @@
           echo "Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md"
           echo "Error: Close this PR and try again."
           exit 1
+
+  Generate-Docs:
+    name: Generate Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Generate documentation
+        run: typedoc --out docs/docs/auto-docs --plugin typedoc-plugin-markdown --theme markdown --tsconfig tsconfig.docs.json --excludePrivate --excludeProtected --excludeExternals --hideGenerator --categorizeByGroup true --entryPointStrategy expand --entryPoints \"src\" --exclude \"src/vite-env.d.ts\" --exclude \"**/*.spec.{ts,tsx}\" --exclude \"**/*.test.{ts,tsx}\" --exclude \"**/__tests__/**\" --exclude \"**/__mocks__/**\" --skipErrorChecking --logLevel Warn"
+
+      - name: Clean up documentation
+        run: |
+          find docs/docs/auto-docs -name 'README.md' -delete
+
+      - name: Commit and push changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -m "Auto-generate documentation"
+          git push origin ${{ github.head_ref }}
 
   Validate-Coderabbit:
     name: Validate CodeRabbit Approval
@@ -460,14 +491,13 @@
         uses: actions/checkout@v4
       - name: Validate CodeRabbit.ai Approval
         run: |
-          chmod +x $GITHUB_WORKSPACE/.github/workflows/scripts/validate-coderabbit.sh
-          $GITHUB_WORKSPACE/.github/workflows/scripts/validate-coderabbit.sh
+          chmod +x .github/workflows/scripts/validate-coderabbit.sh
+          .github/workflows/scripts/validate-coderabbit.sh
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
           GITHUB_REPOSITORY: ${{ github.repository }}
-
-
+
   Python-Compliance:
     name: Check Python Code Style
     runs-on: ubuntu-latest
@@ -516,4 +546,4 @@
       - name: Run docstring compliance check
         run: |
           source venv/bin/activate
-          python .github/workflows/scripts/check_docstrings.py --directories .github
+          python .github/workflows/scripts/check_docstrings.py --directories .github

.github/workflows/push-deploy-website.yml

@@ -1,4 +1,4 @@
 ##############################################################################
 ##############################################################################
 #
 # NOTE!
@@ -24,7 +24,7 @@
     name: Deploy https://docs-admin.talawa.io website
     runs-on: ubuntu-latest
     # Run only if the develop-postgres branch and not dependabot
-    if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop-postgres' }}
+    if: ${{ github.actor != 'dependabot[bot]' }}
     environment:
       # This "name" has to be the repos' branch that contains 
       # the current active website. There must be an entry for
@@ -38,9 +38,7 @@
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 22
-          cache: yarn
-          cache-dependency-path: 'docs/'
+          node-version: '20.x' 
       - uses: webfactory/[email protected]
         with:
           ssh-private-key: ${{ secrets.DEPLOY_GITHUB_PAGES }}

.github/workflows/push.yml

@@ -1,4 +1,4 @@
 ##############################################################################
 ##############################################################################
 #
 # NOTE!
@@ -14,8 +14,8 @@
 on:
   push:
     branches:
-      - '**'   
-      
+      - '**'
+
 env:
     CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}
 

.gitignore

@@ -1,6 +1,9 @@
 # Docusaurus related
 .docusaurus
 
+# generated docs using husky pre-commit hook
+# /docs/docs/auto-docs
+
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # files that interfere with YARN

.husky/pre-commit

@@ -1,4 +1,5 @@
 
+npm run generate-docs
 npm run format:fix
 # npm run lint:fix
 npm run lint-staged

CONTRIBUTING.md

@@ -17,6 +17,12 @@ If you are new to contributing to open source, please read the Open Source Guide
     - [Branching Strategy](#branching-strategy)
     - [Conflict Resolution](#conflict-resolution)
   - [Contributing Code](#contributing-code)
+  - [General:](#general)
+  - [Testing:](#testing)
+    - [Jest Testing](#jest-testing)
+    - [Vitest Testing](#vitest-testing)
+    - [Combined testing and coverage](#combined-testing-and-coverage)
+    - [Test Code Coverage:](#test-code-coverage)
 - [Internships](#internships)
 - [Community](#community)
 
@@ -92,60 +98,94 @@ The process of proposing a change to Talawa Admin can be summarized as:
 1. Run the app and test your changes.
 1. If you've added code, then test suites must be added.
 
-   1. **_General_:**
+   ### General:
 
-      1. We need to get to 100% test coverage for the app. We periodically increase the desired test coverage for our pull requests to meet this goal.
-      1. Pull requests that don't meet the minimum test coverage levels will not be accepted. This may mean that you will have to create tests for code you did not write. You can decide which part of the code base needs additional tests if this happens to you.
+      - We need to get to 100% test coverage for the app. We periodically increase the desired test coverage for our pull requests to meet this goal.
+      - Pull requests that don't meet the minimum test coverage levels will not be accepted. This may mean that you will have to create tests for code you did not write. You can decide which part of the code base needs additional tests if this happens to you.
 
-   2. **_Testing_:**
-
-      1. Test using this set of commands:
+   ### Testing:
 
+   This section outlines the different testing strategies and tools used in this project. It includes instructions on running tests, viewing code coverage, and debugging using Jest and Vitest. Following these guidelines ensures code reliability and maintains the project's high standards for quality.
+      #### Jest Testing
+      - Running a single test:
+         ```
+         npm run test path/to/test/file
+         ```
+      - Running all tests:
+         ```
+         npm run test --watchAll=false
+         ```
+      - Viewing the code coverage of a single test file:
+         ```
+         npm run test --watchAll=false --coverage /path/to/test/file
+         ```
+      - Viewing the code coverage of all test files:
          ```
-         npm install
          npm run test --watchAll=false --coverage
          ```
-
-      2. Debug tests in browser
-
+      - Debug tests in browser
          You can see the output of failing tests in broswer by running `jest-preview` package before running your tests
-
          ```
-         npm install
          npm run jest-preview
          npm run test --watchAll=false --coverage
          ```
-
          You don't need to re-run the `npm run jest-preview` command each time, simply run the `npm run test` command if the Jest Preview server is already running in the background, it'll automatically detect any failing tests and show the preview at `http://localhost:3336` as shown in this screenshot -
 
          ![Debugging Test Demo](./public/images/jest-preview.webp)
+      #### Vitest Testing
+      - Running a single test:
+         ```
+         npm run test:vitest /path/to/test/file
+         ```
+      - Running all tests:
+         ```
+         npm run test:vitest
+         ```
+      - Viewing the code coverage of a single test file:
+         ```
+         npm run test:vitest:coverage /path/to/test/file
+         ```
+      - Viewing the code coverage of all test files:
+         ```
+         npm run test:vitest:coverage
+         ```
+
+      #### Combined testing and coverage
+      - Running all tests:
+         ```
+         npm run test && npm run test:vitest
+         ```
+      - Viewing combined code coverage:
+         ```
+         npm run test --watchAll=false --coverage && npm run test:vitest:coverage            
+         ```
 
-   3. **_Test Code Coverage_:**
+      #### Test Code Coverage:
 
       1. _General Information_
-         1. The current code coverage of the repo is: [![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/talawa-admin)
-         2. You can determine the percentage test coverage of your code by running these two commands in sequence:
+         - The current code coverage of the repo is: [![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/talawa-admin)
+         - You can determine the percentage test coverage of your code by running these two commands in sequence:
             ```
             npm install
             npm run test --watchAll=false --coverage
             genhtml coverage/lcov.info -o coverage
             ```
-         3. The output of the `npm run test` command will give you a tablular coverage report per file
-         4. The overall coverage rate will be visible on the penultimate line of the `genhtml` command's output.
-         5. The `genhtml` command is part of the Linux `lcov` package. Similar packages can be found for Windows and MacOS.
-         6. The currently acceptable coverage rate can be found in the [GitHub Pull Request file](.github/workflows/pull-requests.yml). Search for the value below the line containing `min_coverage`.
+         - The output of the `npm run test` command will give you a tablular coverage report per file
+         - The overall coverage rate will be visible on the penultimate line of the `genhtml` command's output.
+         - The `genhtml` command is part of the Linux `lcov` package. Similar packages can be found for Windows and MacOS.
+         - The currently acceptable coverage rate can be found in the [GitHub Pull Request file](.github/workflows/pull-requests.yml). Search for the value below the line containing `min_coverage`.
       2. _Testing Individual Files_
-         1. You can test an individual file by running this command:
+         - You can test an individual file by running this command:
             ```
             npm run test --watchAll=false /path/to/test/file
             ```
-         2. You can get the test coverage report for that file by running this command. The report will list all tests in the suite. Those tests that are not run will have zero values. You will need to look for the output line relevant to your test file.
+         - You can get the test coverage report for that file by running this command. The report will list all tests in the suite. Those tests that are not run will have zero values. You will need to look for the output line relevant to your test file.
             ```
             npm run test --watchAll=false --coverage /path/to/test/file
             ```
       3. _Creating your code coverage account_
 
-         1. You can also see your code coverage online for your fork of the repo. This is provided by `codecov.io`
+         - You can also see your code coverage online for your fork of the repo. This is provided by `codecov.io`
 
             1. Go to this link: `https://app.codecov.io/gh/XXXX/YYYY` where XXXX is your GitHub account username and YYYY is the name of the repository
             2. Login to `codecov.io` using your GitHub account, and add your **repo** and **branches** to the `codecov.io` dashboard.

docs/docs/CONFIGURING.md

@@ -0,0 +1 @@
+CONFIGURING GUIDE FOR DEVELOPERS

docs/docs/INSTALLATION.md

@@ -0,0 +1 @@
+INSTALLATION GUIDE FOR USERS

docs/docs/auto-docs/App/functions/default.md

@@ -0,0 +1,28 @@
+[Admin Docs](/)
+
+***
+
+# Function: default()
+
+> **default**(): `JSX.Element`
+
+Defined in: [src/App.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/App.tsx#L74)
+
+This is the main function for our application. It sets up all the routes and components,
+defining how the user can navigate through the app. The function uses React Router's `Routes`
+and `Route` components to map different URL paths to corresponding screens and components.
+
+## Important Details
+- **UseEffect Hook**: This hook checks user authentication status using the `CHECK_AUTH` GraphQL query.
+- **Plugins**: It dynamically loads additional routes for any installed plugins.
+- **Routes**:
+  - The root route ("/") takes the user to the `LoginPage`.
+  - Protected routes are wrapped with the `SecuredRoute` component to ensure they are only accessible to authenticated users.
+  - Admin and Super Admin routes allow access to organization and user management screens.
+  - User portal routes allow end-users to interact with organizations, settings, chat, events, etc.
+
+## Returns
+
+`JSX.Element`
+
+The rendered routes and components of the application.

docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md

@@ -0,0 +1,9 @@
+[Admin Docs](/)
+
+***
+
+# Variable: AUTH\_TOKEN
+
+> `const` **AUTH\_TOKEN**: `""` = `''`
+
+Defined in: [src/Constant/constant.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L1)

docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md

@@ -0,0 +1,9 @@
+[Admin Docs](/)
+
+***
+
+# Variable: BACKEND\_URL
+
+> `const` **BACKEND\_URL**: `string` = `process.env.REACT_APP_TALAWA_URL`
+
+Defined in: [src/Constant/constant.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L2)

docs/docs/auto-docs/Constant/constant/variables/REACT_APP_BACKEND_WEBSOCKET_URL.md

@@ -0,0 +1,9 @@
+[Admin Docs](/)
+
+***
+
+# Variable: REACT\_APP\_BACKEND\_WEBSOCKET\_URL
+
+> `const` **REACT\_APP\_BACKEND\_WEBSOCKET\_URL**: `string`
+
+Defined in: [src/Constant/constant.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L6)

docs/docs/auto-docs/Constant/constant/variables/REACT_APP_CUSTOM_PORT.md

@@ -0,0 +1,9 @@
+[Admin Docs](/)
+
+***
+
+# Variable: REACT\_APP\_CUSTOM\_PORT
+
+> `const` **REACT\_APP\_CUSTOM\_PORT**: `string` = `process.env.PORT`
+
+Defined in: [src/Constant/constant.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L5)