Refactor UI folder (#2016)

* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons

* refactoring modules/ui

* refactoring modules/ui

* Change folder case

* Fix theme location

* Fix case 2

* Fix storybook

---------

Co-authored-by: Nimra Ahmed <nimra1408@gmail.com>
Co-authored-by: Nimra Ahmed <50912134+nimraahmed@users.noreply.github.com>

front/src/modules/ui/layout/right-drawer/components/RightDrawer.tsx

@@ -0,0 +1,103 @@
+import { useRef } from 'react';
+import { useTheme } from '@emotion/react';
+import styled from '@emotion/styled';
+import { motion } from 'framer-motion';
+import { useRecoilState } from 'recoil';
+import { Key } from 'ts-key-enum';
+
+import { useScopedHotkeys } from '@/ui/utilities/hotkey/hooks/useScopedHotkeys';
+import {
+  ClickOutsideMode,
+  useListenClickOutside,
+} from '@/ui/utilities/pointer-event/hooks/useListenClickOutside';
+import { useIsMobile } from '@/ui/utilities/responsive/hooks/useIsMobile';
+import { isDefined } from '~/utils/isDefined';
+
+import { leftNavbarWidth } from '../../../navigation/navbar/constants';
+import { useRightDrawer } from '../hooks/useRightDrawer';
+import { isRightDrawerExpandedState } from '../states/isRightDrawerExpandedState';
+import { isRightDrawerOpenState } from '../states/isRightDrawerOpenState';
+import { rightDrawerPageState } from '../states/rightDrawerPageState';
+import { RightDrawerHotkeyScope } from '../types/RightDrawerHotkeyScope';
+
+import { RightDrawerRouter } from './RightDrawerRouter';
+
+const StyledContainer = styled(motion.div)`
+  background: ${({ theme }) => theme.background.primary};
+  box-shadow: ${({ theme }) => theme.boxShadow.strong};
+  height: 100%;
+  overflow-x: hidden;
+  position: fixed;
+
+  right: 0;
+  top: 0;
+  z-index: 100;
+`;
+
+const StyledRightDrawer = styled.div`
+  display: flex;
+  flex-direction: row;
+  width: 100%;
+`;
+
+export const RightDrawer = () => {
+  const [isRightDrawerOpen, setIsRightDrawerOpen] = useRecoilState(
+    isRightDrawerOpenState,
+  );
+
+  const [isRightDrawerExpanded] = useRecoilState(isRightDrawerExpandedState);
+
+  const [rightDrawerPage] = useRecoilState(rightDrawerPageState);
+
+  const { closeRightDrawer } = useRightDrawer();
+
+  const rightDrawerRef = useRef(null);
+
+  useListenClickOutside({
+    refs: [rightDrawerRef],
+    callback: () => closeRightDrawer(),
+    mode: ClickOutsideMode.absolute,
+  });
+
+  const theme = useTheme();
+
+  useScopedHotkeys(
+    [Key.Escape],
+    () => closeRightDrawer(),
+    RightDrawerHotkeyScope.RightDrawer,
+    [setIsRightDrawerOpen],
+  );
+
+  const isMobile = useIsMobile();
+
+  const rightDrawerWidthExpanded = `calc(100% - ${
+    leftNavbarWidth.desktop
+  } - ${theme.spacing(2)})`;
+
+  const rightDrawerWidth = isRightDrawerOpen
+    ? isMobile
+      ? '100%'
+      : isRightDrawerExpanded
+      ? rightDrawerWidthExpanded
+      : theme.rightDrawerWidth
+    : '0';
+
+  if (!isDefined(rightDrawerPage)) {
+    return <></>;
+  }
+
+  return (
+    <StyledContainer
+      animate={{
+        width: rightDrawerWidth,
+      }}
+      transition={{
+        duration: theme.animation.duration.normal,
+      }}
+    >
+      <StyledRightDrawer ref={rightDrawerRef}>
+        {isRightDrawerOpen && <RightDrawerRouter />}
+      </StyledRightDrawer>
+    </StyledContainer>
+  );
+};