Enhance setup.js for Improved Docker Compatibility

.eslintignore

@@ -1,5 +1,17 @@
 # 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
+
+\*.swp
+.vscode/
+
+Dockerfile
+.dockerignore
+.git/
+
+**/\*.yml
+**/_.dockerfile
+\*\*/_.py \*_/_.md

.github/workflows/pull-request.yml

@@ -46,7 +46,7 @@ jobs:
       - 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,25 @@ jobs:
 
       - 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
-
+        run: |
+          # Filter files to include only .ts and .tsx files
+          TS_FILES=$(echo "$CHANGED_FILES" | grep -E '\.(ts|tsx)$')
+
+          # Check if there are any TypeScript files to lint
+          if [ -n "$TS_FILES" ]; then
+            # Run linting on the changed TypeScript files
+            npx eslint $TS_FILES --ignore-pattern '**/*.yml' --ignore-pattern '**/*.dockerfile' --ignore-pattern '**/*.py' --ignore-pattern '**/*.md' --no-ignore
+
+
+
+            # Run the Python script for eslint-disable check on the TypeScript files
+            python .github/workflows/eslint_disable_check.py
+          else
+            echo "No .ts or .tsx files to lint."
+          fi
+
       - name: Check for TSDoc comments
         run: npm run check-tsdoc # Run the TSDoc check script
 
@@ -89,7 +104,7 @@ jobs:
     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 +145,10 @@ jobs:
             *.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 +169,14 @@ jobs:
         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 +216,11 @@ jobs:
 
       - 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 +242,8 @@ jobs:
           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 +264,7 @@ jobs:
       - 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,18 +282,19 @@ jobs:
 
       - 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'
+
   Start-App-Without-Docker:
     name: Check if Talawa Admin app starts (No Docker)
     runs-on: ubuntu-latest
@@ -350,6 +366,7 @@ jobs:
           if [ -f .pidfile_dev ]; then
             kill "$(cat .pidfile_dev)"
           fi
+
   Docker-Start-Check:
     name: Check if Talawa Admin app starts in Docker
     runs-on: ubuntu-latest

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.

scripts/githooks/check-localstorage-usage.js

@@ -7,7 +7,7 @@
 const args = process.argv.slice(2);
 const scanEntireRepo = args.includes('--scan-entire-repo');
 
 const containsSkipComment = (file) => {
   try {
     const content = readFileSync(file, 'utf-8');
     return content.includes('// SKIP_LOCALSTORAGE_CHECK');
@@ -17,7 +17,7 @@
   }
 };
 
 const getModifiedFiles = () => {
   try {
     if (scanEntireRepo) {
       const result = execSync('git ls-files | grep ".tsx\\?$"', {
@@ -40,7 +40,7 @@
 
 const filesWithLocalStorage = [];
 
 const checkLocalStorageUsage = (file) => {
   if (!file) {
     return;
   }
@@ -86,10 +86,10 @@
 
   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.');