Enhance setup.js for Improved Docker Compatibility #2447

.dockerfilelintrc.json

@@ -0,0 +1,5 @@
+{
+  "skipShellCheck": false,
+  "skipCritical": false,
+  "disableLineBreaks": false
+}

.eslintignore

@@ -1,5 +1,3 @@
 # 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

.github/workflows/pull-request.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Run formatting if check fails
         if: failure()
-        run: npm run format
+        run: npm run format:fix
 
       - name: Check for type errors
         if: steps.changed-files.outputs.only_changed != 'true'
@@ -410,4 +410,4 @@ jobs:
         if: github.event.pull_request.base.ref != 'develop-postgres'
         run: |
           echo "Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md"
-          exit 1
+          exit 1

CODE_STYLE.md

@@ -25,7 +25,7 @@ code style should not be changed and must be followed.
 
 - Typescript
 
-- React.js 
+- React.js
 
 - CSS module
 
@@ -43,7 +43,6 @@ code style should not be changed and must be followed.
 
 - Should make use of React hooks where appropriate
 
-
 ## Code Style and Naming Conventions
 
 - All React components *must* be written in PascalCase, with their file names, and associated CSS modules being written in PascalCase
@@ -55,13 +54,15 @@ code style should not be changed and must be followed.
 - Use of custom classes directly are refrained, use of modular css is encouraged along with bootstrap classes
 
 **Wrong way ❌**
+
 ```
 <div className="myCustomClass">...</div>
 <div className={`${styles.myCustomClass1} myCustomClass2`}>...</div> // No using personal custom classes directly, here you should  not use myCustomClass2
 .container{...} // No changing the property of already existing classes reserved by boostrap directly in css files
 ```
 
-**Correct ways ✅** 
+**Correct ways ✅**
+
 ```
 <div className={styles.myCustomClass}>...</div> // Use custom class defined in modular css file
 <div className={`${styles.myCustomClass} relative bg-danger`}>...</div> // Use classes already defined in Bootstrap
@@ -74,7 +75,8 @@ code style should not be changed and must be followed.
 
 **Wrong way ❌**
 
-Using plain Bootstrap classes and attributes without leveraging the React-Bootstrap library should be refrained. While it may work for basic functionality, it doesn't fully integrate with React and may cause issues when dealing with more complex state management or component interactions. 
+Using plain Bootstrap classes and attributes without leveraging the React-Bootstrap library should be refrained. While it may work for basic functionality, it doesn't fully integrate with React and may cause issues when dealing with more complex state management or component interactions.
+
 ```
     <div class="dropdown">
         <button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
@@ -87,11 +89,11 @@ Using plain Bootstrap classes and attributes without leveraging the React-Bootst
         </ul>
     </div>
 ```
-
 
 **Correct way ✅**
 
 It's recommended to use the React-Bootstrap library for seamless integration of Bootstrap components in a React application.
+
 ```
 import Dropdown from 'react-bootstrap/Dropdown';
 
@@ -114,27 +116,27 @@ function BasicExample() {
 export default BasicExample;
 ```
 
+## Test and Code Linting
 
-## Test and Code Linting 
-
-Unit tests must be written for *all* code submissions to the repository, 
+Unit tests must be written for *all* code submissions to the repository,
 the code submitted must also be linted ESLint and formatted with Prettier.
 
 ## Folder/Directory Structure
 
 ### Sub Directories of `src`
 
 `assets` - This houses all of the static assets used in the project
-  - `css` - This houses all of the css files used in the project
-  - `images` - This houses all of the images used in the project
-  - `scss` - This houses all of the scss files used in the project
-    - `components -` All Sass files for components
-    - `content -` All Sass files for content
-    - `forms -` All Sass files for forms
-    - `_talawa.scss` - Partial Sass file for Talawa
-    - `_utilities.scss` - Partial Sass file for utilities
-    - `_variables.scss` - Partial Sass file for variables
-    - `app.scss` - Main Sass file for the app, imports all other partial Sass files
+
+- `css` - This houses all of the css files used in the project
+- `images` - This houses all of the images used in the project
+- `scss` - This houses all of the scss files used in the project
+  - `components -` All Sass files for components
+  - `content -` All Sass files for content
+  - `forms -` All Sass files for forms
+  - `_talawa.scss` - Partial Sass file for Talawa
+  - `_utilities.scss` - Partial Sass file for utilities
+  - `_variables.scss` - Partial Sass file for variables
+  - `app.scss` - Main Sass file for the app, imports all other partial Sass files
 
 `components`  - The directory for base components that will be used in the various views/screens
 
@@ -148,7 +150,6 @@ the code submitted must also be linted ESLint and formatted with Prettier.
 
 `utils` - This holds the utility functions that do not fall into any of the other categories
 
-
 ## Imports
 
 Absolute imports have been set up for the project, so imports may be done directly from `src`.
@@ -161,10 +162,9 @@ import Navbar from 'components/Navbar/Navbar';
 
 Imports should be grouped in the following order:
 
-  - React imports
-  - Third party imports
-  - Local imports
-
+- React imports
+- Third party imports
+- Local imports
 
 If there is more than one import from a single library, they should be grouped together
 
@@ -213,7 +213,6 @@ Follow this [link](https://getbootstrap.com/docs/5.3/customize/sass/) to learn h
   - **_table.scss**
   - **_typography.scss**
 
-
 - `src/assets/scss/forms/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files
   - **_check-radios.scss**
   - **_floating-label.scss**
@@ -245,9 +244,11 @@ To watch the Sass file for changes and compile it automatically, run the followi
 ```
 npx sass src/assets/scss/app.scss src/assets/css/app.css --watch
 ```
+
 The `src/assets/css/app.css.map` file associates the generated CSS code with the original SCSS code. It allows you to see your SCSS code in the browser's developer tools for debugging.
 
 To skip generating the map file, run
+
 ```
 npx sass --no-source-map src/assets/scss/app.scss src/assets/css/app.css
 ```

DOCUMENTATION.md

@@ -1,4 +1,5 @@
 # Documentation
+
 Welcome to our documentation guide. Here are some useful tips you need to know!
 
 # Table of Contents
@@ -15,18 +16,21 @@ Welcome to our documentation guide. Here are some useful tips you need to know!
 
 Our documentation can be found in ONLY TWO PLACES:
 
-1. ***Inline within the repository's code files***: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/). 
-1. ***In our `talawa-docs` repository***: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.
+1. **_Inline within the repository's code files_**: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/).
+1. **_In our `talawa-docs` repository_**: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.
 
 ## How to use Docusaurus
+
 The process in easy:
+
 1. Install `talawa-docs` on your system
-1. Launch docusaurus on your system according to the `talawa-docs`documentation. 
-    - A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
+1. Launch docusaurus on your system according to the `talawa-docs`documentation.
+   - A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
 1. Add/modify the markdown documents to the `docs/` directory of the `talawa-docs` repository
 1. If adding a file, then you will also need to edit the `sidebars.js` which is used to generate the [docs.talawa.io](https://docs.talawa.io/) menus.
-1. Always monitor the local website in your brower to make sure the changes are acceptable. 
-    - You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.
+1. Always monitor the local website in your browser to make sure the changes are acceptable.
+   - You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.
 
 ## Other information
-***PLEASE*** do not add markdown files in this repository. Add them to `talawa-docs`!
+
+**_PLEASE_** do not add markdown files in this repository. Add them to `talawa-docs`!

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

@@ -63,20 +63,23 @@ First you need a local copy of `talawa-admin`. Run the following command in the
       ![Image of user's clone](public/markdown/images/install2.png)
 
    1. Clone the repository to your local computer (replacing the values in `{{}}`):
+
       ```bash
       $ git clone https://github.com/{{YOUR GITHUB USERNAME}}/talawa-admin.git
       cd talawa-admin
       git checkout develop
       ```
+
       - **Note:** Make sure to check out the `develop` branch
+
    1. You now have a local copy of the code files. For more detailed instructions on contributing code, and managing the versions of this repository with `git`, checkout our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
 
 4. **Talawa Administrators:**
 
    1. Clone the repository to your local computer using this command:
 
       ```bash
-      $ git clone https://github.com/PalisadoesFoundation/talawa-admin.git
+      git clone https://github.com/PalisadoesFoundation/talawa-admin.git
       ```
 
 ## Install node.js
@@ -86,7 +89,7 @@ Best way to install and manage `node.js` is making use of node version managers.
 Follow these steps to install the `node.js` packages in Windows, Linux and MacOS.
 
 1. For Windows:
-   1. first install `node.js` from their website at https://nodejs.org
+   1. first install `node.js` from their website at <https://nodejs.org>
       1. When installing, don't click the option to install the `necessary tools`. These are not needed in our case.
    2. then install [fnm](https://github.com/Schniz/fnm). Please read all the steps in this section first.
       1. All the commands listed on this page will need to be run in a Windows terminal session in the `talawa-admin` directory.
@@ -141,9 +144,9 @@ The prerequisites are now installed. The next step will be to get the app up and
 
 If you prefer to use Docker, you can install the app using the following command:
 
-1.  Create a `.env` file as described in the Configuration section
+1. Create a `.env` file as described in the Configuration section
 
-2.  Build the Docker Image:
+2. Build the Docker Image:
 
 Run the following command to build the Docker image:
 
@@ -155,12 +158,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.
@@ -205,23 +228,23 @@ Add the endpoint for accessing talawa-api graphql service to the variable named
 
 ```
 
-REACT_APP_TALAWA_URL="http://API-IP-ADRESS:4000/graphql/"
+REACT_APP_TALAWA_URL="<http://API-IP-ADRESS:4000/graphql/>"
 
 ```
 
 If you are a software developer working on your local system, then the URL would be:
 
 ```
 
-REACT_APP_TALAWA_URL="http://localhost:4000/graphql/"
+REACT_APP_TALAWA_URL="<http://localhost:4000/graphql/>"
 
 ```
 
 If you are trying to access Talawa Admin from a remote host with the API URL containing "localhost", You will have to change the API URL to
 
 ```
 
-REACT_APP_TALAWA_URL="http://YOUR-REMOTE-ADDRESS:4000/graphql/"
+REACT_APP_TALAWA_URL="<http://YOUR-REMOTE-ADDRESS:4000/graphql/>"
 
 ```
 
@@ -297,15 +320,15 @@ By default `talawa-admin` runs on port `4321` on your system's localhost. It is
 
 ```
 
-http://localhost:4321/
+<http://localhost:4321/>
 
 ```
 
 If you have specified a custom port number in your `.env` file, Talawa-Admin will run on the following endpoint:
 
 ```
 
-http://localhost:${{customPort}}/
+<http://localhost:${{customPort}}/>
 
 ```
 

ISSUE_GUIDELINES.md

@@ -4,7 +4,8 @@
 
 In order to give everyone a chance to submit a issues reports and contribute to the Talawa project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in the Talawa project.
 
-___
+---
+
 ## Table of Contents
 
 <!-- toc -->
@@ -18,15 +19,17 @@ ___
 
 <!-- tocstop -->
 
-___
+---
+
 ## Issue Management
 
 In all cases please use the [GitHub open issue search](https://github.com/PalisadoesFoundation/talawa-admin/issues) to check whether the issue has already been reported.
 
 ### New Issues
+
 To create new issues follow these steps:
 
-1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created. 
+1. Your issue may have already been created. Search for duplicate open issues before submitting yours.for similar deficiencies in the code.duplicate issues are created.
 1. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository.
 1. Click on the [`New Issue`](https://github.com/PalisadoesFoundation/talawa-admin/issues/new/choose) button
 1. Use the templates to create a standardized report of what needs to be done and why.
@@ -49,11 +52,12 @@ Working on these types of existing issues is a good way of getting started with
 
 Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible.
 
-### Monitoring the Creation of New Issues 
+### Monitoring the Creation of New Issues
+
 1. Join our `#talawa-github` slack channel for automatic issue and pull request updates.
 
 ## General Guidelines
 
 1. Discuss issues in our various slack channels when necessary
-2. Please do not derail or troll issues. 
+2. Please do not derail or troll issues.
 3. Keep the discussion on topic and respect the opinions of others.

PR_GUIDELINES.md

@@ -47,6 +47,7 @@ npm run format:check
 1. Please read our [CONTRIBUTING.md](CONTRIBUTING.md) document for details on our testing policy.
 
 ## Pull Request Processing
+
 These are key guidelines for the procedure:
 
 ### Only submit PRs against our `develop` branch, not the default `main` branch