Updated talawa admin docs

docs/talawa-admin-docs/_media/INSTALLATION.md

@@ -17,6 +17,7 @@ This document provides instructions on how to set up and start a running instanc
   - [Creating .env file](#creating-env-file)
   - [Setting up PORT in .env file](#setting-up-port-in-env-file)
   - [Setting up REACT_APP_TALAWA_URL in .env file](#setting-up-react_app_talawa_url-in-env-file)
+  - [Setting up REACT_APP_BACKEND_WEBSOCKET_URL in .env file](#setting-up-react_app_backend_websocket_url-in-env-file)
   - [Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file](#setting-up-react_app_recaptcha_site_key-in-env-file)
   - [Setting up Compiletime and Runtime logs](#setting-up-compiletime-and-runtime-logs)
 - [Post Configuration Steps](#post-configuration-steps)
@@ -65,31 +66,34 @@ First you need a local copy of `talawa-admin`. Run the following command in the
 
 1. On your computer, navigate to the folder where you want to setup the repository.
 2. Open a `cmd` (Windows) or `terminal` (Linux or MacOS) session in this folder.
-    1. An easy way to do this is to right-click and choose appropriate option based on your OS.
+   1. An easy way to do this is to right-click and choose appropriate option based on your OS.
 3. **For Our Open Source Contributor Software Developers:**
-    1. Next, we'll fork and clone the `talawa-admin` repository.
-    1. In your web browser, navigate to [https://github.com/PalisadoesFoundation/talawa-admin/](https://github.com/PalisadoesFoundation/talawa-admin/) and click on the `fork` button. It is placed on the right corner opposite the repository name `PalisadoesFoundation/talawa-admin`.
 
-       ![Image with fork](public/markdown/images/install1.png)
+   1. Next, we'll fork and clone the `talawa-admin` repository.
+   1. In your web browser, navigate to [https://github.com/PalisadoesFoundation/talawa-admin/](https://github.com/PalisadoesFoundation/talawa-admin/) and click on the `fork` button. It is placed on the right corner opposite the repository name `PalisadoesFoundation/talawa-admin`.
 
-    2. You should now see `talawa-admin` under your repositories. It will be marked as forked from `PalisadoesFoundation/talawa-admin`
+      ![Image with fork](public/markdown/images/install1.png)
 
-       ![Image of user's clone](public/markdown/images/install2.png)
+   1. You should now see `talawa-admin` under your repositories. It will be marked as forked from `PalisadoesFoundation/talawa-admin`
+
+      ![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.
 
-    3. 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
-    4. 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
-          ```
+   1. Clone the repository to your local computer using this command:
+
+      ```bash
+      $ git clone https://github.com/PalisadoesFoundation/talawa-admin.git
+      ```
 
 ## Install node.js
 
@@ -98,26 +102,26 @@ 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. 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.
-        2. Install `fnm` using the `winget` option listed on the page.
-        3. Setup `fnm` to automatically set the version of `node.js` to the version required for the repository using these steps:
-            1. First, refer to the `fnm` web page's section on `Shell Setup` recommendations.
-            2. Open a `Windows PowerShell` terminal window
-            3. Run the recommended `Windows PowerShell` command to open `notepad`.
-            4. Paste the recommended string into `notepad`
-            5. Save the document.
-            6. Exit `notepad`
-            7. Exit PowerShell
-            8. This will ensure that you are always using the correct version of `node.js`
+   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.
+      2. Install `fnm` using the `winget` option listed on the page.
+      3. Setup `fnm` to automatically set the version of `node.js` to the version required for the repository using these steps:
+         1. First, refer to the `fnm` web page's section on `Shell Setup` recommendations.
+         2. Open a `Windows PowerShell` terminal window
+         3. Run the recommended `Windows PowerShell` command to open `notepad`.
+         4. Paste the recommended string into `notepad`
+         5. Save the document.
+         6. Exit `notepad`
+         7. Exit PowerShell
+         8. This will ensure that you are always using the correct version of `node.js`
 2. For Linux and MacOS, use the terminal window.
    1. install `node.js`
    2. then install `fnm`
-         1. Refer to the installation page's section on the `Shell Setup` recommendations.
-         2. Run the respective recommended commands to setup your node environment
-         3. This will ensure that you are always using the correct version of `node.js`
+      1. Refer to the installation page's section on the `Shell Setup` recommendations.
+      2. Run the respective recommended commands to setup your node environment
+      3. This will ensure that you are always using the correct version of `node.js`
 
 ## Install TypeScript
 
@@ -163,14 +167,15 @@ cp .env.example .env
 
 This `.env` file must be populated with the following environment variables for `talawa-admin` to work:
 
-| Variable                     | Description                                       |
-| ---------------------------- | ------------------------------------------------- |
-| PORT                         | Custom port for Talawa-Admin development purposes |
-| REACT_APP_TALAWA_URL         | URL endpoint for talawa-api graphql service       |
-| REACT_APP_USE_RECAPTCHA      | Whether you want to use reCAPTCHA or not          |
-| REACT_APP_RECAPTCHA_SITE_KEY | Site key for authentication using reCAPTCHA       |
+| Variable                        | Description                                       |
+| ------------------------------- | ------------------------------------------------- |
+| PORT                            | Custom port for Talawa-Admin development purposes |
+| REACT_APP_TALAWA_URL            | URL endpoint for talawa-api graphql service       |
+| REACT_APP_BACKEND_WEBSOCKET_URL | URL endpoint for websocket end point              |
+| REACT_APP_USE_RECAPTCHA         | Whether you want to use reCAPTCHA or not          |
+| REACT_APP_RECAPTCHA_SITE_KEY    | Site key for authentication using reCAPTCHA       |
 
-Follow the instructions from the sections [Setting up PORT in .env file](#setting-up-port-in-env-file), [Setting up REACT_APP_TALAWA_URL in .env file](#setting-up-REACT_APP_TALAWA_URL-in-env-file), [Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file](#setting-up-REACT_APP_RECAPTCHA_SITE_KEY-in-env-file) and [Setting up Compiletime and Runtime logs](#setting-up-compiletime-and-runtime-logs) to set up these environment variables.
+Follow the instructions from the sections [Setting up PORT in .env file](#setting-up-port-in-env-file), [Setting up REACT_APP_TALAWA_URL in .env file](#setting-up-REACT_APP_TALAWA_URL-in-env-file), [Setting up REACT_APP_BACKEND_WEBSOCKET_URL in .env file](#setting-up-react_app_backend_websocket_url-in-env-file), [Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file](#setting-up-REACT_APP_RECAPTCHA_SITE_KEY-in-env-file) and [Setting up Compiletime and Runtime logs](#setting-up-compiletime-and-runtime-logs) to set up these environment variables.
 
 ## Setting up PORT in .env file
 
@@ -196,7 +201,27 @@ If you are trying to access Talawa Admin from a remote host with the API URL con
 REACT_APP_TALAWA_URL="http://YOUR-REMOTE-ADDRESS:4000/graphql/"
 ```
 
-For additional details, please refer  the `How to Access the Talawa-API URL` section in the INSTALLATION.md file found in the [Talawa-API repo](https://github.com/PalisadoesFoundation/talawa-api).
+## Setting up REACT_APP_BACKEND_WEBSOCKET_URL in .env file
+
+The endpoint for accessing talawa-api WebSocket graphql service for handling subscriptions is automatically added to the variable named `REACT_APP_BACKEND_WEBSOCKET_URL` in the `.env` file.
+
+```
+REACT_APP_BACKEND_WEBSOCKET_URL="ws://API-IP-ADRESS:4000/graphql/"
+```
+
+If you are a software developer working on your local system, then the URL would be:
+
+```
+REACT_APP_BACKEND_WEBSOCKET_URL="ws://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_BACKEND_WEBSOCKET_URL="ws://YOUR-REMOTE-ADDRESS:4000/graphql/"
+```
+
+For additional details, please refer the `How to Access the Talawa-API URL` section in the INSTALLATION.md file found in the [Talawa-API repo](https://github.com/PalisadoesFoundation/talawa-api).
 
 ## Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file
 

docs/talawa-admin-docs/components/AddOn/AddOn/functions/default.md

@@ -24,4 +24,4 @@ The JSX element representing the AddOn component.
 
 ## Defined in
 
-[src/components/AddOn/AddOn.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/AddOn.tsx#L22)
+[src/components/AddOn/AddOn.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/AddOn.tsx#L22)

docs/talawa-admin-docs/components/AddOn/core/AddOnEntry/AddOnEntry/functions/default.md

@@ -40,4 +40,4 @@ A JSX element containing the add-on entry.
 
 ## Defined in
 
-[src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx#L46)
+[src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx#L46)

docs/talawa-admin-docs/components/AddOn/core/AddOnEntry/AddOnEntryMocks/variables/ADD_ON_ENTRY_MOCK.md

@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts#L13)
+[src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts#L13)

docs/talawa-admin-docs/components/AddOn/core/AddOnRegister/AddOnRegister/functions/default.md

@@ -19,7 +19,7 @@ This component:
 
 ## Parameters
 
-• **\_\_namedParameters**: `AddOnRegisterProps`
+• **\_\_namedParameters**: `InterfaceAddOnRegisterProps`
 
 ## Returns
 
@@ -29,4 +29,4 @@ A JSX element containing the button and modal for plugin registration.
 
 ## Defined in
 
-[src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx#L38)
+[src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx#L38)

docs/talawa-admin-docs/components/AddOn/core/AddOnStore/AddOnStore/functions/default.md

@@ -24,4 +24,4 @@ A JSX element containing the UI for the add-on store.
 
 ## Defined in
 
-[src/components/AddOn/core/AddOnStore/AddOnStore.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/core/AddOnStore/AddOnStore.tsx#L26)
+[src/components/AddOn/core/AddOnStore/AddOnStore.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/core/AddOnStore/AddOnStore.tsx#L26)

docs/talawa-admin-docs/components/AddOn/support/components/Action/Action/functions/default.md

@@ -32,4 +32,4 @@ A JSX element containing the label and child elements.
 
 ## Defined in
 
-[src/components/AddOn/support/components/Action/Action.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/components/Action/Action.tsx#L29)
+[src/components/AddOn/support/components/Action/Action.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/components/Action/Action.tsx#L29)

docs/talawa-admin-docs/components/AddOn/support/components/MainContent/MainContent/functions/default.md

@@ -32,4 +32,4 @@ A JSX element containing the main content container with the provided child elem
 
 ## Defined in
 
-[src/components/AddOn/support/components/MainContent/MainContent.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/components/MainContent/MainContent.tsx#L25)
+[src/components/AddOn/support/components/MainContent/MainContent.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/components/MainContent/MainContent.tsx#L25)

docs/talawa-admin-docs/components/AddOn/support/components/SidePanel/SidePanel/functions/default.md

@@ -32,4 +32,4 @@ A JSX element containing the side panel with the provided child elements.
 
 ## Defined in
 
-[src/components/AddOn/support/components/SidePanel/SidePanel.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/components/SidePanel/SidePanel.tsx#L30)
+[src/components/AddOn/support/components/SidePanel/SidePanel.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/components/SidePanel/SidePanel.tsx#L30)

docs/talawa-admin-docs/components/AddOn/support/services/Plugin.helper/classes/default.md

@@ -34,7 +34,7 @@ A promise that resolves to the installed plugins data in JSON format.
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/services/Plugin.helper.ts#L21)
+[src/components/AddOn/support/services/Plugin.helper.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/services/Plugin.helper.ts#L21)
 
 ***
 
@@ -52,7 +52,7 @@ A promise that resolves to the store data in JSON format.
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/services/Plugin.helper.ts#L11)
+[src/components/AddOn/support/services/Plugin.helper.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/services/Plugin.helper.ts#L11)
 
 ***
 
@@ -76,4 +76,4 @@ An array of objects containing the name and URL of each enabled plugin.
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddOn/support/services/Plugin.helper.ts#L32)
+[src/components/AddOn/support/services/Plugin.helper.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddOn/support/services/Plugin.helper.ts#L32)

docs/talawa-admin-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md

@@ -26,4 +26,4 @@
 
 ## Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L42)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L42)

docs/talawa-admin-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md

@@ -16,7 +16,7 @@ Props for the `AddPeopleToTag` component.
 
 #### Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L29)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L29)
 
 ***
 
@@ -30,7 +30,7 @@ Props for the `AddPeopleToTag` component.
 
 #### Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L30)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L30)
 
 ***
 
@@ -44,7 +44,7 @@ Props for the `AddPeopleToTag` component.
 
 #### Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L31)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L31)
 
 ***
 
@@ -54,7 +54,7 @@ Props for the `AddPeopleToTag` component.
 
 #### Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L32)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L32)
 
 ***
 
@@ -64,4 +64,4 @@ Props for the `AddPeopleToTag` component.
 
 #### Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTag.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L33)
+[src/components/AddPeopleToTag/AddPeopleToTag.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L33)

docs/talawa-admin-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md

@@ -10,4 +10,4 @@
 
 ## Defined in
 
-[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/9dd5d7fd647f8a7c9e1c1e14bf645b71b32c51c2/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5)
+[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/d16b95ee179900e8e32a2296f14e948e6caea05b/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5)