Update documentation

package.json

@@ -48,6 +48,7 @@
     "react-toastify": "^9.0.3",
     "redux": "^4.1.1",
     "redux-thunk": "^2.3.0",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^4.3.5",
     "web-vitals": "^1.0.1"
   },
@@ -86,24 +87,27 @@
   },
   "devDependencies": {
     "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
-    "@types/enzyme": "^3.10.9",
-    "@types/js-cookie": "^3.0.2",
-    "@types/react": "^17.0.14",
-    "@types/react-router-dom": "^5.1.8",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^11.1.0",
     "@testing-library/user-event": "^12.1.10",
+    "@types/enzyme": "^3.10.9",
     "@types/jest": "^26.0.24",
-    "@types/node": "^12.20.16",
+    "@types/js-cookie": "^3.0.2",
+    "@types/node": "^12.20.55",
+    "@types/react": "^17.0.14",
     "@types/react-bootstrap": "^0.32.32",
     "@types/react-datepicker": "^4.1.4",
     "@types/react-dom": "^17.0.9",
     "@types/react-google-recaptcha": "^2.1.5",
+    "@types/react-router-dom": "^5.1.8",
+    "@typescript-eslint/eslint-plugin": "^5.9.0",
+    "@typescript-eslint/parser": "^5.9.0",
     "@wojtekmaj/enzyme-adapter-react-17": "^0.8.0",
     "cross-env": "^7.0.3",
+    "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^25.3.4",
+    "eslint-plugin-prettier": "^3.4.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "husky": "^8.0.3",
     "identity-obj-proxy": "^3.0.0",
@@ -112,10 +116,7 @@
     "jest-localstorage-mock": "^2.4.19",
     "jest-location-mock": "^1.0.9",
     "jest-preview": "^0.3.1",
-    "postcss-modules": "^6.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jest": "^25.3.4",
-    "eslint-plugin-prettier": "^3.4.0"
+    "postcss-modules": "^6.0.0"
   },
   "resolutions": {
     "@apollo/client": "^3.4.0-beta.19",

talawa-admin-docs/README.md

@@ -3,6 +3,8 @@ talawa-admin / [Modules](modules.md)
 # Talawa Admin
 💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file.
 
+![talawa-logo-lite-200x200](https://github.com/PalisadoesFoundation/talawa-admin/assets/16875803/26291ec5-d3c1-4135-8bc7-80885dff613d)
+
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-admin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin)
 [![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/talawa-admin.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin)
@@ -20,6 +22,16 @@ Core features include:
 
 `talawa` is based on the original `quito` code created by the [Palisadoes Foundation][pfd] as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit [The Palisadoes Foundation's website](http://www.palisadoes.org/) for more details on its origin and activities.
 
+# Table of Contents
+
+\<!-- toc --\>
+
+- [Talawa Components](#talawa-components)
+- [Documentation](#documentation)
+- [Installation](#installation)
+
+\<!-- tocstop --\>
+
 # Talawa Components
 
 `talawa` has these major software components:

talawa-admin-docs/classes/components_AddOn_support_services_Plugin_helper.default.md

@@ -20,7 +20,11 @@
 
 ### constructor
 
-• **new default**()
+• **new default**(): [`default`](components_AddOn_support_services_Plugin_helper.default.md)
+
+#### Returns
+
+[`default`](components_AddOn_support_services_Plugin_helper.default.md)
 
 ## Methods
 
@@ -34,7 +38,7 @@
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/AddOn/support/services/Plugin.helper.ts#L7)
+[src/components/AddOn/support/services/Plugin.helper.ts:7](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/AddOn/support/services/Plugin.helper.ts#L7)
 
 ___
 
@@ -48,7 +52,7 @@ ___
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/AddOn/support/services/Plugin.helper.ts#L2)
+[src/components/AddOn/support/services/Plugin.helper.ts:2](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/AddOn/support/services/Plugin.helper.ts#L2)
 
 ___
 
@@ -68,4 +72,4 @@ ___
 
 #### Defined in
 
-[src/components/AddOn/support/services/Plugin.helper.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/AddOn/support/services/Plugin.helper.ts#L12)
+[src/components/AddOn/support/services/Plugin.helper.ts:12](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/AddOn/support/services/Plugin.helper.ts#L12)

talawa-admin-docs/classes/components_AddOn_support_services_Render_helper.default.md

@@ -14,4 +14,8 @@
 
 ### constructor
 
-• **new default**()
+• **new default**(): [`default`](components_AddOn_support_services_Render_helper.default.md)
+
+#### Returns
+
+[`default`](components_AddOn_support_services_Render_helper.default.md)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceAttendeeCheckIn.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L8)
+[src/components/CheckIn/types.ts:8](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L8)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L10)
+[src/components/CheckIn/types.ts:10](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L10)
 
 ___
 
@@ -40,4 +40,4 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L9)
+[src/components/CheckIn/types.ts:9](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L9)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceAttendeeQueryResponse.md

@@ -25,4 +25,4 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L19)
+[src/components/CheckIn/types.ts:19](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L19)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceModalProp.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L27)
+[src/components/CheckIn/types.ts:27](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L27)
 
 ___
 
@@ -38,7 +38,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L28)
+[src/components/CheckIn/types.ts:28](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L28)
 
 ___
 
@@ -48,4 +48,4 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L26)
+[src/components/CheckIn/types.ts:26](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L26)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceTableCheckIn.md

@@ -22,7 +22,7 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L35)
+[src/components/CheckIn/types.ts:35](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L35)
 
 ___
 
@@ -32,7 +32,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L41)
+[src/components/CheckIn/types.ts:41](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L41)
 
 ___
 
@@ -42,7 +42,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L32)
+[src/components/CheckIn/types.ts:32](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L32)
 
 ___
 
@@ -52,7 +52,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L33)
+[src/components/CheckIn/types.ts:33](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L33)
 
 ___
 
@@ -62,4 +62,4 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L34)
+[src/components/CheckIn/types.ts:34](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L34)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceTableData.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L47)
+[src/components/CheckIn/types.ts:47](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L47)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L46)
+[src/components/CheckIn/types.ts:46](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L46)
 
 ___
 
@@ -40,4 +40,4 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L45)
+[src/components/CheckIn/types.ts:45](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L45)

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceUser.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L2)
+[src/components/CheckIn/types.ts:2](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L2)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L3)
+[src/components/CheckIn/types.ts:3](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L3)
 
 ___
 
@@ -40,4 +40,4 @@ ___
 
 #### Defined in
 
-[src/components/CheckIn/types.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CheckIn/types.ts#L4)
+[src/components/CheckIn/types.ts:4](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CheckIn/types.ts#L4)

talawa-admin-docs/interfaces/components_CollapsibleDropdown_CollapsibleDropdown.InterfaceCollapsibleDropdown.md

@@ -19,7 +19,7 @@
 
 #### Defined in
 
-[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L9)
+[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:9](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L9)
 
 ___
 
@@ -29,4 +29,4 @@ ___
 
 #### Defined in
 
-[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L10)
+[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L10)

talawa-admin-docs/interfaces/components_IconComponent_IconComponent.InterfaceIconComponent.md

@@ -21,7 +21,7 @@
 
 #### Defined in
 
-[src/components/IconComponent/IconComponent.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/IconComponent/IconComponent.tsx#L14)
+[src/components/IconComponent/IconComponent.tsx:18](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/IconComponent/IconComponent.tsx#L18)
 
 ___
 
@@ -31,7 +31,7 @@ ___
 
 #### Defined in
 
-[src/components/IconComponent/IconComponent.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/IconComponent/IconComponent.tsx#L15)
+[src/components/IconComponent/IconComponent.tsx:19](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/IconComponent/IconComponent.tsx#L19)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[src/components/IconComponent/IconComponent.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/IconComponent/IconComponent.tsx#L13)
+[src/components/IconComponent/IconComponent.tsx:17](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/IconComponent/IconComponent.tsx#L17)
 
 ___
 
@@ -51,4 +51,4 @@ ___
 
 #### Defined in
 
-[src/components/IconComponent/IconComponent.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/b619a0d/src/components/IconComponent/IconComponent.tsx#L16)
+[src/components/IconComponent/IconComponent.tsx:20](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/IconComponent/IconComponent.tsx#L20)

talawa-admin-docs/interfaces/components_LeftDrawerEvent_LeftDrawerEvent.InterfaceLeftDrawerProps.md

@@ -0,0 +1,64 @@
+[talawa-admin](../README.md) / [Modules](../modules.md) / [components/LeftDrawerEvent/LeftDrawerEvent](../modules/components_LeftDrawerEvent_LeftDrawerEvent.md) / InterfaceLeftDrawerProps
+
+# Interface: InterfaceLeftDrawerProps
+
+[components/LeftDrawerEvent/LeftDrawerEvent](../modules/components_LeftDrawerEvent_LeftDrawerEvent.md).InterfaceLeftDrawerProps
+
+## Table of contents
+
+### Properties
+
+- [event](components_LeftDrawerEvent_LeftDrawerEvent.InterfaceLeftDrawerProps.md#event)
+- [hideDrawer](components_LeftDrawerEvent_LeftDrawerEvent.InterfaceLeftDrawerProps.md#hidedrawer)
+- [setHideDrawer](components_LeftDrawerEvent_LeftDrawerEvent.InterfaceLeftDrawerProps.md#sethidedrawer)
+- [setShowAddEventProjectModal](components_LeftDrawerEvent_LeftDrawerEvent.InterfaceLeftDrawerProps.md#setshowaddeventprojectmodal)
+
+## Properties
+
+### event
+
+• **event**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `_id` | `string` |
+| `description` | `string` |
+| `organization` | \{ `_id`: `string`  \} |
+| `organization._id` | `string` |
+| `title` | `string` |
+
+#### Defined in
+
+[src/components/LeftDrawerEvent/LeftDrawerEvent.tsx:16](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/LeftDrawerEvent/LeftDrawerEvent.tsx#L16)
+
+___
+
+### hideDrawer
+
+• **hideDrawer**: ``null`` \| `boolean`
+
+#### Defined in
+
+[src/components/LeftDrawerEvent/LeftDrawerEvent.tsx:24](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/LeftDrawerEvent/LeftDrawerEvent.tsx#L24)
+
+___
+
+### setHideDrawer
+
+• **setHideDrawer**: `Dispatch`\<`SetStateAction`\<``null`` \| `boolean`\>\>
+
+#### Defined in
+
+[src/components/LeftDrawerEvent/LeftDrawerEvent.tsx:25](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/LeftDrawerEvent/LeftDrawerEvent.tsx#L25)
+
+___
+
+### setShowAddEventProjectModal
+
+• **setShowAddEventProjectModal**: `Dispatch`\<`SetStateAction`\<`boolean`\>\>
+
+#### Defined in
+
+[src/components/LeftDrawerEvent/LeftDrawerEvent.tsx:26](https://github.com/palisadoes/talawa-admin/blob/018fcc9/src/components/LeftDrawerEvent/LeftDrawerEvent.tsx#L26)