Enhance setup.js for Improved Docker Compatibility

.eslintignore

@@ -1,5 +1,15 @@
 # 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
+
+Dockerfile
+
+_.yml
+_.yaml
+
+\*.md
+
+package.json

.eslintrc.json

@@ -1,4 +1,4 @@
 {
   "env": {
     "browser": true,
     "node": true,
@@ -66,13 +66,7 @@
     "@typescript-eslint/array-type": "error",
     "@typescript-eslint/consistent-type-assertions": "error",
     "@typescript-eslint/consistent-type-imports": "error",
-    "@typescript-eslint/explicit-function-return-type": [
-      2,
-      {
-        "allowExpressions": true,
-        "allowTypedFunctionExpressions": true
-      }
-    ],
+    "@typescript-eslint/explicit-function-return-type": "off",
     "camelcase": "off",
     "@typescript-eslint/naming-convention": [
       "error",

.github/workflows/pull-request.yml

@@ -1,4 +1,4 @@
 ##############################################################################
 ##############################################################################
 #
 # NOTE!
@@ -46,7 +46,7 @@
       - name: Check formatting
         if: steps.changed-files.outputs.only_changed != 'true'
         run: npm run format:check
-        
+
       - name: Run formatting if check fails
         if: failure()
         run: npm run format
@@ -57,10 +57,10 @@
 
       - name: Check for linting errors in modified files
         if: steps.changed-files.outputs.only_changed != 'true'
-        env: 
+        env:
           CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
-        
+
       - name: Check for TSDoc comments
         run: npm run check-tsdoc # Run the TSDoc check script
 
@@ -89,7 +89,7 @@
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      
+
       - name: Get Changed Unauthorized files
         id: changed-unauth-files
         uses: tj-actions/changed-files@v45
@@ -130,10 +130,10 @@
             *.password
             *.secret
             *.credentials
-            
+
       - name: List all changed unauthorized files
         if: steps.changed-unauth-files.outputs.any_changed == 'true' || steps.changed-unauth-files.outputs.any_deleted == 'true'
-        env: 
+        env:
           CHANGED_UNAUTH_FILES: ${{ steps.changed-unauth-files.outputs.all_changed_files }}
         run: |
           for file in ${CHANGED_UNAUTH_FILES}; do
@@ -154,14 +154,14 @@
         uses: tj-actions/changed-files@v45
 
       - name: Echo number of changed files
-        env: 
+        env:
           CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
         run: |
           echo "Number of files changed: $CHANGED_FILES_COUNT"
 
       - name: Check if the number of changed files is less than 100
         if: steps.changed-files.outputs.all_changed_files_count > 100
-        env: 
+        env:
           CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
         run: |
           echo "Error: Too many files (greater than 100) changed in the pull request."
@@ -201,11 +201,11 @@
 
       - name: Install Dependencies
         run: npm install
-      
+
       - name: Get changed TypeScript files
         id: changed-files
         uses: tj-actions/changed-files@v45
-          
+
       - name: Run Jest Tests
         if: steps.changed-files.outputs.only_changed != 'true'
         env:
@@ -227,8 +227,8 @@
           if ! npx lcov-result-merger 'coverage/*/lcov.info' > 'coverage/lcov.info'; then
             echo "Failed to merge coverage reports"
             exit 1
-          fi     
-      
+          fi
+
       - name: TypeScript compilation for changed files
         run: |
           for file in ${{ steps.changed-files.outputs.all_files }}; do
@@ -249,7 +249,7 @@
       - name: Test acceptable level of code coverage
         uses: VeryGoodOpenSource/very_good_coverage@v3
         with:
-          path: "./coverage/lcov.info"
+          path: './coverage/lcov.info'
           min_coverage: 0.0
 
   Graphql-Inspector:
@@ -267,15 +267,15 @@
 
       - name: resolve dependency
         run: npm install -g @graphql-inspector/cli
-      
+
       - name: Clone API Repository
         run: |
           # Retrieve the complete branch name directly from the GitHub context
           FULL_BRANCH_NAME=${{ github.base_ref }}
           echo "FULL_Branch_NAME: $FULL_BRANCH_NAME"
-          
+
           # Clone the specified repository using the extracted branch name
-          git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a 
+          git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a
 
       - name: Validate Documents
         run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20.10.0 AS build
+FROM node:20.10.0-alpine AS build
 
 WORKDIR /usr/src/app
 
@@ -12,4 +12,4 @@ RUN npm run build
 
 EXPOSE 4321
 
-CMD ["npm", "run", "serve"]
+CMD ["npm", "run", "serve"]

INSTALLATION.md

@@ -155,12 +155,32 @@ docker build -t talawa-admin .
 
 After the build is complete, run the Docker container using this command:
 
+For Linux/MacOS
 ```bash
-docker run -p 4321:4321 talawa-admin
+docker run -d \
+  --name talawa-admin \
+  -p 4321:4321 \
+  -v $(pwd)/.env:/app/.env \
+  talawa-admin
+
 ```bash
 
+For Windows
+docker run -d `
+  --name talawa-admin `
+  -p 4321:4321 `
+  -v ${PWD}\.env:/app/.env `
+  talawa-admin
+
+
 The application will be accessible at `http://localhost:4321`
 
+4. Managing the container:
+
+To stop the container:
+```bash
+docker stop talawa-admin
+
 # Configuration
 
 It's important to configure Talawa-Admin. Here's how to do it.

jest.config.js

@@ -10,7 +10,8 @@ export default {
     '!**/index.{js,ts}',
     '!**/*.d.ts',
     '!src/test/**',
-    '!vitest.config.ts',],
+    '!vitest.config.ts',
+  ],
   // setupFiles: ['react-app-polyfill/jsdom'],
   setupFiles: ['whatwg-fetch'],
   setupFilesAfterEnv: ['<rootDir>/src/setupTests.ts'],

scripts/githooks/check-localstorage-usage.js

@@ -86,10 +86,10 @@ if (filesWithLocalStorage.length > 0) {
 
   console.info(
     '\x1b[34m%s\x1b[0m',
-    '\nInfo: Consider using custom hook functions.'
+    '\nInfo: Consider using custom hook functions.',
   );
   console.info(
-    'Please use the getItem, setItem, and removeItem functions provided by the custom hook useLocalStorage.\n'
+    'Please use the getItem, setItem, and removeItem functions provided by the custom hook useLocalStorage.\n',
   );
 
   process.exit(1);

scripts/githooks/update-toc.js

@@ -8,7 +8,6 @@ const markdownFiles = fs
 markdownFiles.forEach((file) => {
   const command = `markdown-toc -i "${file}" --bullets "-"`;
   execSync(command, { stdio: 'inherit' });
-
 });
 
 console.log('Table of contents updated successfully.');