From 872967476a243b28c377e5850e865f439a5a98f0 Mon Sep 17 00:00:00 2001 From: gautam-divyanshu <> Date: Sun, 24 Nov 2024 01:19:54 +0000 Subject: [PATCH] Updated talawa admin docs --- docs/talawa-admin-docs/_media/INSTALLATION.md | 89 ++++++++++++++----- .../AddOn/AddOn/functions/default.md | 2 +- .../AddOnEntry/functions/default.md | 2 +- .../variables/ADD_ON_ENTRY_MOCK.md | 2 +- .../AddOnRegister/functions/default.md | 2 +- .../AddOnStore/functions/default.md | 2 +- .../Action/Action/functions/default.md | 2 +- .../MainContent/functions/default.md | 2 +- .../SidePanel/SidePanel/functions/default.md | 2 +- .../services/Plugin.helper/classes/default.md | 6 +- .../AddPeopleToTag/functions/default.md | 2 +- .../InterfaceAddPeopleToTagProps.md | 10 +-- .../AddPeopleToTagsMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../Advertisements/functions/default.md | 2 +- .../AdvertisementEntry/functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR_MUTATIONS.md | 2 +- .../variables/props.md | 2 +- .../variables/props2.md | 2 +- .../AgendaItemsContainer/functions/default.md | 2 +- .../variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../variables/props.md | 2 +- .../variables/props2.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../Avatar/Avatar/functions/default.md | 2 +- .../functions/default.md | 2 +- .../CheckInModal/functions/CheckInModal.md | 2 +- .../functions/CheckInWrapper.md | 2 +- .../CheckIn/TableRow/functions/TableRow.md | 2 +- .../mocks/variables/checkInMutationSuccess.md | 2 +- .../variables/checkInMutationUnsuccess.md | 2 +- .../mocks/variables/checkInQueryMock.md | 2 +- .../tagTemplate/variables/tagTemplate.md | 2 +- .../interfaces/InterfaceAttendeeCheckIn.md | 6 +- .../InterfaceAttendeeQueryResponse.md | 2 +- .../types/interfaces/InterfaceModalProp.md | 6 +- .../types/interfaces/InterfaceTableCheckIn.md | 10 +-- .../types/interfaces/InterfaceTableData.md | 6 +- .../CheckIn/types/interfaces/InterfaceUser.md | 6 +- .../CollapsibleDropdown/functions/default.md | 2 +- .../InterfaceCollapsibleDropdown.md | 6 +- .../ContriStats/functions/default.md | 2 +- .../CurrentHourIndicator/functions/default.md | 2 +- .../DynamicDropDown/functions/default.md | 2 +- .../functions/default.md | 2 +- .../EventCalendar/functions/default.md | 2 +- .../EventHeader/functions/default.md | 2 +- .../YearlyEventCalender/functions/default.md | 2 +- .../constants/variables/holidays.md | 2 +- .../constants/variables/hours.md | 2 +- .../constants/variables/months.md | 2 +- .../constants/variables/weekdays.md | 2 +- .../EventDashboardScreen/functions/default.md | 2 +- .../EventListCard/functions/default.md | 2 +- .../interfaces/InterfaceEventListCardProps.md | 38 ++++---- .../variables/ERROR_MOCKS.md | 2 +- .../EventListCardMocks/variables/MOCKS.md | 2 +- .../EventListCardModals/functions/default.md | 2 +- .../EventListCardProps/variables/props.md | 2 +- .../variables/MOCKS_WITHOUT_TIME.md | 2 +- .../variables/MOCKS_WITH_TIME.md | 2 +- .../EventDashboard/functions/default.md | 2 +- .../EventAgendaItems/functions/default.md | 2 +- .../EventAgendaItemsMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR_MUTATION.md | 2 +- .../variables/MOCKS_ERROR_QUERY.md | 2 +- .../Attendance.mocks/variables/MOCKS.md | 2 +- .../Attendance.mocks/variables/MOCKS_ERROR.md | 2 +- .../AttendedEventList/functions/default.md | 2 +- .../EventAttendance/functions/default.md | 2 +- .../functions/AttendanceStatisticsModal.md | 2 +- ...InterfaceAttendanceStatisticsModalProps.md | 10 +-- .../interfaces/InterfaceEvent.md | 32 +++---- .../interfaces/InterfaceMember.md | 20 ++--- .../interfaces/InterfaceRecurringEvent.md | 18 ++-- .../AddOnSpotAttendee/functions/default.md | 2 +- .../functions/EventRegistrantsModal.md | 2 +- .../functions/EventRegistrantsWrapper.md | 2 +- .../EventStats/functions/EventStats.md | 2 +- .../functions/EventStatsWrapper.md | 2 +- .../AverageRating/functions/AverageRating.md | 2 +- .../Feedback/functions/FeedbackStats.md | 2 +- .../Review/functions/ReviewStats.md | 2 +- .../HolidayCard/functions/default.md | 2 +- .../IconComponent/functions/default.md | 2 +- .../interfaces/InterfaceIconComponent.md | 8 +- .../InfiniteScrollLoader/functions/default.md | 2 +- .../LeftDrawer/functions/default.md | 2 +- .../interfaces/InterfaceLeftDrawerProps.md | 4 +- .../LeftDrawerOrg/functions/default.md | 2 +- .../interfaces/InterfaceLeftDrawerProps.md | 8 +- .../Loader/Loader/functions/default.md | 2 +- .../LoginPortalToggle/functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../interfaces/InterfaceCardItem.md | 14 +-- .../functions/default.md | 2 +- .../functions/CustomTableCell.md | 2 +- .../MemberRequestCard/functions/default.md | 2 +- .../NotFound/NotFound/functions/default.md | 2 +- .../OrgAdminListCard/functions/default.md | 2 +- .../OrgContriCards/functions/default.md | 2 +- .../OrgDelete/OrgDelete/functions/default.md | 2 +- .../OrgListCard/functions/default.md | 2 +- .../interfaces/InterfaceOrgListCardProps.md | 2 +- .../OrgPeopleListCard/functions/default.md | 2 +- .../OrgPostCard/functions/default.md | 2 +- .../CategoryModal/functions/default.md | 2 +- .../InterfaceActionItemCategoryModal.md | 12 +-- .../functions/default.md | 2 +- .../variables/MOCKS.md | 2 +- .../variables/MOCKS_EMPTY.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- .../functions/default.md | 2 +- ...S_ERROR_AGENDA_ITEM_CATEGORY_LIST_QUERY.md | 2 +- .../variables/MOCKS_ERROR_MUTATION.md | 2 +- .../variables/MOCKS.md | 2 +- .../DeleteOrg/DeleteOrg/functions/default.md | 2 +- .../GeneralSettings/functions/default.md | 2 +- .../functions/default.md | 2 +- .../OrgUpdate/OrgUpdate/functions/default.md | 2 +- .../OrgUpdateMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR_ORGLIST.md | 2 +- .../variables/MOCKS_ERROR_UPDATE_ORGLIST.md | 2 +- .../OrganizationCard/functions/default.md | 2 +- .../functions/default.md | 2 +- .../CardItem/functions/default.md | 2 +- .../CardItem/interfaces/InterfaceCardItem.md | 14 +-- .../CardItemLoading/functions/default.md | 2 +- .../DashboardCard/functions/default.md | 2 +- .../DashboardCardLoading/functions/default.md | 2 +- .../OrganizationScreen/functions/default.md | 2 +- .../Pagination/functions/default.md | 2 +- .../PaginationList/functions/default.md | 2 +- .../ProfileDropdown/functions/default.md | 2 +- .../functions/default.md | 2 +- .../RecurrenceOptions/functions/default.md | 2 +- .../RequestsTableItem/functions/default.md | 2 +- .../interfaces/InterfaceRequestsListItem.md | 4 +- .../RequestsTableItemMocks/variables/MOCKS.md | 2 +- .../SecuredRoute/functions/default.md | 2 +- .../SuperAdminScreen/functions/default.md | 2 +- .../TableLoader/functions/default.md | 2 +- .../interfaces/InterfaceTableLoader.md | 6 +- .../TagActions/functions/default.md | 2 +- .../interfaces/InterfaceTagActionsProps.md | 10 +-- .../TagActionsMocks/variables/MOCKS.md | 2 +- .../MOCKS_ERROR_ORGANIZATION_TAGS_QUERY.md | 2 +- .../variables/MOCKS_ERROR_SUBTAGS_QUERY.md | 2 +- .../TagActions/TagNode/functions/default.md | 2 +- .../UpdateSession/functions/default.md | 2 +- .../UserListCard/functions/default.md | 2 +- .../UserPasswordUpdate/functions/default.md | 2 +- .../ChatRoom/ChatRoom/functions/default.md | 2 +- .../CommentCard/functions/default.md | 2 +- .../ContactCard/functions/default.md | 2 +- .../CreateDirectChat/functions/default.md | 2 +- .../CreateGroupChat/functions/default.md | 2 +- .../DonationCard/functions/default.md | 2 +- .../EventCard/EventCard/functions/default.md | 2 +- .../OrganizationCard/functions/default.md | 2 +- .../OrganizationNavbar/functions/default.md | 2 +- .../OrganizationSidebar/functions/default.md | 2 +- .../PeopleCard/functions/default.md | 2 +- .../PostCard/PostCard/functions/default.md | 2 +- .../PromotedPost/functions/default.md | 2 +- .../Register/Register/functions/default.md | 2 +- .../SecuredRouteForUser/functions/default.md | 2 +- .../StartPostModal/functions/default.md | 2 +- .../UserNavbar/functions/default.md | 2 +- .../functions/EventsAttendedByUser.md | 2 +- .../functions/UserAddressFields.md | 2 +- .../UserSidebar/functions/default.md | 2 +- .../interfaces/InterfaceUserSidebarProps.md | 4 +- .../UserSidebarOrg/functions/default.md | 2 +- .../InterfaceUserSidebarOrgProps.md | 8 +- .../DeleteUser/functions/default.md | 2 +- .../OtherSettings/functions/default.md | 2 +- .../UserProfile/functions/default.md | 2 +- .../UserTableItemMocks/variables/MOCKS.md | 2 +- .../UserTableItemMocks/variables/MOCKS2.md | 2 +- .../variables/MOCKS_UPDATE.md | 2 +- .../UsersTableItem/functions/default.md | 2 +- .../Venues/VenueCard/functions/default.md | 2 +- .../Venues/VenueModal/functions/default.md | 2 +- .../interfaces/InterfaceVenueModalProps.md | 12 +-- .../DummyPlugin/functions/default.md | 2 +- .../DummyPlugin2/functions/default.md | 2 +- .../BlockUser/BlockUser/functions/default.md | 2 +- .../CommunityProfile/functions/default.md | 2 +- .../EventManagement/functions/default.md | 2 +- .../Requests.mocks/variables/EMPTY_MOCKS.md | 2 +- .../Requests.mocks/variables/ERROR_MOCKS.md | 2 +- .../Requests.mocks/variables/MOCKS.md | 2 +- .../variables/UPDATE_ERROR_MOCKS.md | 2 +- .../Requests/Requests/functions/default.md | 2 +- .../VolunteerContainer/functions/default.md | 2 +- .../functions/default.md | 2 +- .../InterfaceDeleteVolunteerGroupModal.md | 8 +- .../VolunteerGroupModal/functions/default.md | 2 +- .../InterfaceVolunteerGroupModal.md | 14 +-- .../functions/default.md | 2 +- .../InterfaceVolunteerGroupViewModal.md | 6 +- .../VolunteerGroups.mocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_EMPTY.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../VolunteerGroups/functions/default.md | 2 +- .../VolunteerCreateModal/functions/default.md | 2 +- .../InterfaceVolunteerCreateModal.md | 10 +-- .../VolunteerDeleteModal/functions/default.md | 2 +- .../InterfaceDeleteVolunteerModal.md | 8 +- .../VolunteerViewModal/functions/default.md | 2 +- .../interfaces/InterfaceVolunteerViewModal.md | 6 +- .../Volunteers.mocks/variables/MOCKS.md | 2 +- .../Volunteers.mocks/variables/MOCKS_EMPTY.md | 2 +- .../Volunteers.mocks/variables/MOCKS_ERROR.md | 2 +- .../Volunteers/functions/default.md | 2 +- .../ForgotPassword/functions/default.md | 2 +- .../FundCampaignPledge/functions/default.md | 2 +- .../PledgeDeleteModal/functions/default.md | 2 +- .../interfaces/InterfaceDeletePledgeModal.md | 8 +- .../PledgeModal/functions/default.md | 2 +- .../interfaces/InterfacePledgeModal.md | 16 ++-- .../PledgesMocks/variables/EMPTY_MOCKS.md | 2 +- .../PledgesMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_DELETE_PLEDGE_ERROR.md | 2 +- .../MOCKS_FUND_CAMPAIGN_PLEDGE_ERROR.md | 2 +- .../variables/PLEDGE_MODAL_MOCKS.md | 2 +- .../variables/EMPTY_MOCKS.md | 2 +- .../variables/ERROR_MOCKS.md | 2 +- .../Leaderboard.mocks/variables/MOCKS.md | 2 +- .../Leaderboard/functions/default.md | 2 +- .../LoginPage/LoginPage/functions/default.md | 2 +- .../EditUserTagModal/functions/default.md | 2 +- .../InterfaceEditUserTagModalProps.md | 14 +-- .../ManageTag/ManageTag/functions/default.md | 2 +- .../MockAddPeopleToTag/functions/default.md | 2 +- .../MockTagActions/functions/default.md | 2 +- .../ManageTagMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR_ASSIGNED_MEMBERS.md | 2 +- .../RemoveUserTagModal/functions/default.md | 2 +- .../InterfaceRemoveUserTagModalProps.md | 10 +-- .../UnassignUserTagModal/functions/default.md | 2 +- .../InterfaceUnassignUserTagModalProps.md | 10 +-- .../MemberDetail/functions/default.md | 2 +- .../MemberDetail/functions/getLanguageName.md | 2 +- .../MemberDetail/functions/prettyDate.md | 2 +- .../MemberDetailMocks/variables/MOCKS1.md | 2 +- .../MemberDetailMocks/variables/MOCKS2.md | 2 +- .../MemberDetailMocks/variables/MOCKS3.md | 2 +- .../OrgContribution/functions/default.md | 2 +- .../OrgList/OrgList/functions/default.md | 2 +- .../OrgList/OrgListMocks/variables/MOCKS.md | 2 +- .../OrgListMocks/variables/MOCKS_ADMIN.md | 2 +- .../OrgListMocks/variables/MOCKS_EMPTY.md | 2 +- .../variables/MOCKS_WITH_ERROR.md | 2 +- .../OrganizationModal/functions/default.md | 2 +- .../OrgPost/OrgPost/functions/default.md | 2 +- .../OrgSettings.mocks/variables/MOCKS.md | 2 +- .../OrgSettings/functions/default.md | 2 +- .../ItemDeleteModal/functions/default.md | 2 +- .../InterfaceItemDeleteModalProps.md | 8 +- .../ItemModal/functions/default.md | 2 +- .../interfaces/InterfaceItemModalProps.md | 14 +-- .../functions/default.md | 2 +- .../InterfaceItemUpdateStatusModalProps.md | 8 +- .../ItemViewModal/functions/default.md | 2 +- .../interfaces/InterfaceViewModalProps.md | 6 +- .../variables/MOCKS.md | 2 +- .../variables/MOCKS_EMPTY.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../functions/default.md | 2 +- .../variables/actionItemCategory1.md | 2 +- .../variables/actionItemCategory2.md | 2 +- .../variables/actionItemCategoryListQuery.md | 2 +- .../variables/baseActionItem.md | 2 +- .../variables/groupListQuery.md | 2 +- .../variables/itemWithGroup.md | 2 +- .../variables/itemWithUser.md | 2 +- .../variables/itemWithUserImage.md | 2 +- .../variables/itemWithVolunteer.md | 2 +- .../variables/itemWithVolunteerImage.md | 2 +- .../variables/memberListQuery.md | 2 +- .../variables/volunteerListQuery.md | 2 +- .../functions/default.md | 2 +- .../variables/EMPTY_MOCKS.md | 2 +- .../variables/ERROR_MOCKS.md | 2 +- .../variables/MOCKS.md | 2 +- .../enumerations/ViewType.md | 6 +- .../OrganizationEvents/functions/default.md | 2 +- .../variables/MOCKS.md | 2 +- .../CampaignModal/functions/default.md | 2 +- .../interfaces/InterfaceCampaignModal.md | 14 +-- .../functions/default.md | 2 +- .../variables/EMPTY_MOCKS.md | 2 +- .../variables/MOCKS.md | 2 +- .../variables/MOCK_ERROR.md | 2 +- .../FundModal/functions/default.md | 2 +- .../interfaces/InterfaceFundModal.md | 12 +-- .../OrganizationFunds/functions/default.md | 2 +- .../OrganizationFundsMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../variables/NO_FUNDS.md | 2 +- .../AddMember/functions/default.md | 2 +- .../MockDataTypes/type-aliases/TestMock.md | 2 +- .../OrganizationPeople/functions/default.md | 2 +- .../OrganizationTags/functions/default.md | 2 +- .../OrganizationTagsMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR.md | 2 +- .../OrganizationVenues/functions/default.md | 2 +- .../PageNotFound/functions/default.md | 2 +- .../Requests/Requests/functions/default.md | 2 +- .../RequestsMocks/variables/EMPTY_MOCKS.md | 2 +- .../variables/EMPTY_REQUEST_MOCKS.md | 2 +- .../Requests/RequestsMocks/variables/MOCKS.md | 2 +- .../RequestsMocks/variables/MOCKS2.md | 2 +- .../RequestsMocks/variables/MOCKS3.md | 2 +- .../RequestsMocks/variables/MOCKS4.md | 2 +- .../variables/MOCKS_WITH_ERROR.md | 2 +- .../SubTags/SubTags/functions/default.md | 2 +- .../SubTags/SubTagsMocks/variables/MOCKS.md | 2 +- .../variables/MOCKS_ERROR_SUB_TAGS.md | 2 +- .../Campaigns/Campaigns/functions/default.md | 2 +- .../CampaignsMocks/variables/EMPTY_MOCKS.md | 2 +- .../CampaignsMocks/variables/MOCKS.md | 2 +- .../variables/USER_FUND_CAMPAIGNS_ERROR.md | 2 +- .../PledgeModal/functions/default.md | 2 +- .../interfaces/InterfacePledgeModal.md | 16 ++-- .../UserPortal/Chat/Chat/functions/default.md | 2 +- .../Donate/Donate/functions/default.md | 2 +- .../interfaces/InterfaceDonationCardProps.md | 12 +-- .../Events/Events/functions/default.md | 2 +- .../Organizations/functions/default.md | 2 +- .../People/People/functions/default.md | 2 +- .../Pledges/Pledges/functions/default.md | 2 +- .../PledgesMocks/variables/EMPTY_MOCKS.md | 2 +- .../Pledges/PledgesMocks/variables/MOCKS.md | 2 +- .../variables/USER_PLEDGES_ERROR.md | 2 +- .../Posts/Posts/functions/default.md | 2 +- .../Settings/Settings/functions/default.md | 2 +- .../UserScreen/functions/default.md | 2 +- .../Actions.mocks/variables/EMPTY_MOCKS.md | 2 +- .../Actions.mocks/variables/ERROR_MOCKS.md | 2 +- .../Actions/Actions.mocks/variables/MOCKS.md | 2 +- .../Actions/Actions/functions/default.md | 2 +- .../Groups/GroupModal/functions/default.md | 2 +- .../interfaces/InterfaceGroupModal.md | 10 +-- .../Groups.mocks/variables/EMPTY_MOCKS.md | 2 +- .../Groups.mocks/variables/ERROR_MOCKS.md | 2 +- .../Groups/Groups.mocks/variables/MOCKS.md | 2 +- .../variables/UPDATE_ERROR_MOCKS.md | 2 +- .../Groups/Groups/functions/default.md | 2 +- .../variables/EMPTY_MOCKS.md | 2 +- .../variables/ERROR_MOCKS.md | 2 +- .../Invitations.mocks/variables/MOCKS.md | 2 +- .../variables/UPDATE_ERROR_MOCKS.md | 2 +- .../Invitations/functions/default.md | 2 +- .../variables/CREATE_ERROR_MOCKS.md | 2 +- .../variables/EMPTY_MOCKS.md | 2 +- .../variables/ERROR_MOCKS.md | 2 +- .../UpcomingEvents.mocks/variables/MOCKS.md | 2 +- .../UpcomingEvents/functions/default.md | 2 +- .../VolunteerManagement/functions/default.md | 2 +- .../screens/Users/Users/functions/default.md | 2 +- .../Users/UsersMocks/variables/EMPTY_MOCKS.md | 2 +- .../Users/UsersMocks/variables/MOCKS.md | 2 +- .../Users/UsersMocks/variables/MOCKS2.md | 2 +- 378 files changed, 645 insertions(+), 600 deletions(-) diff --git a/docs/talawa-admin-docs/_media/INSTALLATION.md b/docs/talawa-admin-docs/_media/INSTALLATION.md index 326bff8616a..167711c3da9 100644 --- a/docs/talawa-admin-docs/_media/INSTALLATION.md +++ b/docs/talawa-admin-docs/_media/INSTALLATION.md @@ -13,25 +13,9 @@ This document provides instructions on how to set up and start a running instanc - [Install node.js](#install-nodejs) - [Install TypeScript](#install-typescript) - [Install Required Packages](#install-required-packages) -- [Configuration](#configuration) - - [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) - - [Running Talawa-Admin](#running-talawa-admin) - - [Accessing Talawa-Admin](#accessing-talawa-admin) - - [Talawa-Admin Registration](#talawa-admin-registration) - - [Talawa-Admin Login](#talawa-admin-login) -- [Testing](#testing) - - [Running tests](#running-tests) - - [Debugging tests](#debugging-tests) - - [Linting code files](#linting-code-files) - - [Husky for Git Hooks](#husky-for-git-hooks) - - [pre-commit hook](#pre-commit-hook) - - [post-merge hook](#post-merge-hook) +- [Installation using Docker](#installation-using-docker) + - [Prerequisites](#prerequisites-1) + - [Development Setup](#development-setup) \