From 8a7a4bb608af8826f2a37b4ae5fc6cb6aa3424ff Mon Sep 17 00:00:00 2001 From: Vasilica Olariu Date: Fri, 10 Jan 2025 13:33:51 +0200 Subject: [PATCH 1/3] Rename admin to skills-manager --- src/apps/admin/src/index.ts | 4 ---- src/apps/platform/src/platform.routes.tsx | 4 ++-- src/apps/{admin => skills-manager}/README.md | 0 src/apps/{admin => skills-manager}/index.tsx | 0 .../src/SkillsManagerApp.tsx} | 6 +++--- src/apps/skills-manager/src/index.ts | 4 ++++ .../src/skills-manager.routes.tsx} | 18 +++++++++--------- .../src/skills-manager/SkillsManager.tsx | 0 .../components/accordion/Accordion.module.scss | 0 .../components/accordion/Accordion.tsx | 0 .../accordion-item/AccordionItem.module.scss | 0 .../accordion/accordion-item/AccordionItem.tsx | 0 .../accordion/accordion-item/index.ts | 0 .../components/accordion/index.ts | 0 .../actions-menu/ActionsMenu.module.scss | 0 .../components/actions-menu/ActionsMenu.tsx | 0 .../components/actions-menu/index.ts | 0 .../bulk-editor/BulkEditor.module.scss | 0 .../components/bulk-editor/BulkEditor.tsx | 0 .../ArchiveSkillsModal.module.scss | 0 .../ArchiveSkillsModal.tsx | 0 .../bulk-editor/archive-skills-modal/index.ts | 0 .../components/bulk-editor/index.ts | 0 .../MoveSkillsModal.module.scss | 0 .../move-skills-modal/MoveSkillsModal.tsx | 0 .../bulk-editor/move-skills-modal/index.ts | 0 .../ReplaceSkillsModal.module.scss | 0 .../ReplaceSkillsModal.tsx | 0 .../bulk-editor/replace-skills-modal/index.ts | 0 .../search-skill-input/SearchSkillInput.tsx | 0 .../bulk-editor/search-skill-input/index.ts | 0 .../CategoriesAccordion.module.scss | 0 .../CategoriesAccordion.tsx | 0 .../components/categories-accordion/index.ts | 0 .../category-modal/CategoryModal.module.scss | 0 .../category-modal/CategoryModal.tsx | 0 .../category-modal/category-form.config.ts | 0 .../components/category-modal/index.ts | 0 .../src/skills-manager/components/index.ts | 0 .../MoreActionsMenu.module.scss | 0 .../more-actions-menu/MoreActionsMenu.tsx | 0 .../components/more-actions-menu/index.ts | 0 .../page-header/PageHeader.module.scss | 0 .../components/page-header/PageHeader.tsx | 0 .../components/page-header/index.ts | 0 .../search-input/SearchInput.module.scss | 0 .../components/search-input/SearchInput.tsx | 0 .../components/search-input/index.ts | 0 .../skill-modals/SkillModal.module.scss | 0 .../components/skill-modals/SkillModal.tsx | 0 .../components/skill-modals/index.ts | 0 .../SimilarSkillsDropdown.module.scss | 0 .../SimilarSkillsDropdown.tsx | 0 .../similar-skills-dropdown/index.ts | 0 .../skill-form/SkillForm.module.scss | 0 .../skill-modals/skill-form/SkillForm.tsx | 0 .../skill-modals/skill-form/index.ts | 0 .../skills-list/SkillsList.module.scss | 0 .../components/skills-list/SkillsList.tsx | 0 .../components/skills-list/index.ts | 0 .../src/skills-manager/config/constants.ts | 0 .../src/skills-manager/config/index.ts | 0 .../src/skills-manager/context/index.ts | 0 .../context/skills-manager.context.tsx | 0 .../context/use-skills-bulk-editor-context.tsx | 0 .../src/skills-manager/index.ts | 0 .../landing-page/LandingPage.module.scss | 0 .../landing-page/LandingPage.tsx | 0 .../src/skills-manager/landing-page/index.ts | 0 .../src/skills-manager/lib/index.ts | 0 .../src/skills-manager/lib/skills.utils.ts | 0 .../src/skills-manager/services/index.ts | 0 .../services/skills-categories.service.ts | 0 .../skills-manager/services/skills.service.ts | 0 .../skills-manager/skills-manager.routes.tsx | 0 src/config/constants.ts | 4 ++-- 76 files changed, 20 insertions(+), 20 deletions(-) delete mode 100644 src/apps/admin/src/index.ts rename src/apps/{admin => skills-manager}/README.md (100%) rename src/apps/{admin => skills-manager}/index.tsx (100%) rename src/apps/{admin/src/AdminApp.tsx => skills-manager/src/SkillsManagerApp.tsx} (78%) create mode 100644 src/apps/skills-manager/src/index.ts rename src/apps/{admin/src/admin.routes.tsx => skills-manager/src/skills-manager.routes.tsx} (51%) rename src/apps/{admin => skills-manager}/src/skills-manager/SkillsManager.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/Accordion.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/Accordion.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/accordion-item/AccordionItem.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/accordion-item/AccordionItem.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/accordion-item/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/accordion/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/actions-menu/ActionsMenu.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/actions-menu/ActionsMenu.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/actions-menu/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/BulkEditor.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/BulkEditor.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/archive-skills-modal/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/move-skills-modal/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/replace-skills-modal/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/search-skill-input/SearchSkillInput.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/bulk-editor/search-skill-input/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/categories-accordion/CategoriesAccordion.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/categories-accordion/CategoriesAccordion.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/categories-accordion/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/category-modal/CategoryModal.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/category-modal/CategoryModal.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/category-modal/category-form.config.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/category-modal/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/more-actions-menu/MoreActionsMenu.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/more-actions-menu/MoreActionsMenu.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/more-actions-menu/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/page-header/PageHeader.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/page-header/PageHeader.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/page-header/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/search-input/SearchInput.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/search-input/SearchInput.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/search-input/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/SkillModal.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/SkillModal.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/similar-skills-dropdown/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/skill-form/SkillForm.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/skill-form/SkillForm.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skill-modals/skill-form/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skills-list/SkillsList.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skills-list/SkillsList.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/components/skills-list/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/config/constants.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/config/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/context/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/context/skills-manager.context.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/context/use-skills-bulk-editor-context.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/landing-page/LandingPage.module.scss (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/landing-page/LandingPage.tsx (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/landing-page/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/lib/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/lib/skills.utils.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/services/index.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/services/skills-categories.service.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/services/skills.service.ts (100%) rename src/apps/{admin => skills-manager}/src/skills-manager/skills-manager.routes.tsx (100%) diff --git a/src/apps/admin/src/index.ts b/src/apps/admin/src/index.ts deleted file mode 100644 index db1cc3082..000000000 --- a/src/apps/admin/src/index.ts +++ /dev/null @@ -1,4 +0,0 @@ -export { - adminRoutes, - rootRoute as adminRootRoute, -} from './admin.routes' diff --git a/src/apps/platform/src/platform.routes.tsx b/src/apps/platform/src/platform.routes.tsx index c59367c88..e8f84d70d 100644 --- a/src/apps/platform/src/platform.routes.tsx +++ b/src/apps/platform/src/platform.routes.tsx @@ -9,7 +9,7 @@ import { profilesRoutes } from '~/apps/profiles' import { talentSearchRoutes } from '~/apps/talent-search' import { accountsRoutes } from '~/apps/accounts' import { onboardingRoutes } from '~/apps/onboarding' -import { adminRoutes } from '~/apps/admin' +import { skillsManagerRoutes } from '~/apps/skills-manager' import { walletRoutes } from '~/apps/wallet' import { walletAdminRoutes } from '~/apps/wallet-admin' @@ -41,6 +41,6 @@ export const platformRoutes: Array = [ ...walletRoutes, ...walletAdminRoutes, ...accountsRoutes, - ...adminRoutes, + ...skillsManagerRoutes, ...homeRoutes, ] diff --git a/src/apps/admin/README.md b/src/apps/skills-manager/README.md similarity index 100% rename from src/apps/admin/README.md rename to src/apps/skills-manager/README.md diff --git a/src/apps/admin/index.tsx b/src/apps/skills-manager/index.tsx similarity index 100% rename from src/apps/admin/index.tsx rename to src/apps/skills-manager/index.tsx diff --git a/src/apps/admin/src/AdminApp.tsx b/src/apps/skills-manager/src/SkillsManagerApp.tsx similarity index 78% rename from src/apps/admin/src/AdminApp.tsx rename to src/apps/skills-manager/src/SkillsManagerApp.tsx index 5c80d2a69..42c521c7e 100644 --- a/src/apps/admin/src/AdminApp.tsx +++ b/src/apps/skills-manager/src/SkillsManagerApp.tsx @@ -4,9 +4,9 @@ import { Outlet, Routes } from 'react-router-dom' import { routerContext, RouterContextData } from '~/libs/core' import { SharedSwrConfig } from '~/libs/shared' -import { toolTitle } from './admin.routes' +import { toolTitle } from './skills-manager.routes' -const AdminApp: FC<{}> = () => { +const SkillsManagerApp: FC<{}> = () => { const { getChildRoutes }: RouterContextData = useContext(routerContext) return ( @@ -19,4 +19,4 @@ const AdminApp: FC<{}> = () => { ) } -export default AdminApp +export default SkillsManagerApp diff --git a/src/apps/skills-manager/src/index.ts b/src/apps/skills-manager/src/index.ts new file mode 100644 index 000000000..6b1936c79 --- /dev/null +++ b/src/apps/skills-manager/src/index.ts @@ -0,0 +1,4 @@ +export { + skillsManagerRoutes, + rootRoute as skillsManagerRootRoute, +} from './skills-manager.routes' diff --git a/src/apps/admin/src/admin.routes.tsx b/src/apps/skills-manager/src/skills-manager.routes.tsx similarity index 51% rename from src/apps/admin/src/admin.routes.tsx rename to src/apps/skills-manager/src/skills-manager.routes.tsx index e275ec8fd..2ed9fc105 100644 --- a/src/apps/admin/src/admin.routes.tsx +++ b/src/apps/skills-manager/src/skills-manager.routes.tsx @@ -3,30 +3,30 @@ import { Navigate } from 'react-router-dom' import { lazyLoad, LazyLoadedComponent, PlatformRoute, UserRole } from '~/libs/core' import { AppSubdomain, EnvironmentConfig, ToolTitle } from '~/config' -import { skillsManagerRootRoute, skillsManagerRoutes } from './skills-manager' +import { skillsManagerRootRoute, skillsManagerRoutes as skillsManagerChildRoutes } from './skills-manager' -const AdminApp: LazyLoadedComponent = lazyLoad(() => import('./AdminApp')) +const SkillsManagerApp: LazyLoadedComponent = lazyLoad(() => import('./SkillsManagerApp')) export const rootRoute: string = ( - EnvironmentConfig.SUBDOMAIN === AppSubdomain.admin ? '' : `/${AppSubdomain.admin}` + EnvironmentConfig.SUBDOMAIN === AppSubdomain.skillsManager ? '' : `/${AppSubdomain.skillsManager}` ) -export const toolTitle: string = ToolTitle.admin +export const toolTitle: string = ToolTitle.skillsManager export const absoluteRootRoute: string = `${window.location.origin}${rootRoute}` -export const adminRoutes: ReadonlyArray = [ +export const skillsManagerRoutes: ReadonlyArray = [ { authRequired: true, children: [ - ...skillsManagerRoutes, + ...skillsManagerChildRoutes, { element: , - id: 'Default Admin Route', + id: 'Default SkillsManager Route', route: '', }, ], - domain: AppSubdomain.admin, - element: , + domain: AppSubdomain.skillsManager, + element: , id: toolTitle, rolesRequired: [UserRole.administrator], route: rootRoute, diff --git a/src/apps/admin/src/skills-manager/SkillsManager.tsx b/src/apps/skills-manager/src/skills-manager/SkillsManager.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/SkillsManager.tsx rename to src/apps/skills-manager/src/skills-manager/SkillsManager.tsx diff --git a/src/apps/admin/src/skills-manager/components/accordion/Accordion.module.scss b/src/apps/skills-manager/src/skills-manager/components/accordion/Accordion.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/Accordion.module.scss rename to src/apps/skills-manager/src/skills-manager/components/accordion/Accordion.module.scss diff --git a/src/apps/admin/src/skills-manager/components/accordion/Accordion.tsx b/src/apps/skills-manager/src/skills-manager/components/accordion/Accordion.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/Accordion.tsx rename to src/apps/skills-manager/src/skills-manager/components/accordion/Accordion.tsx diff --git a/src/apps/admin/src/skills-manager/components/accordion/accordion-item/AccordionItem.module.scss b/src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/AccordionItem.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/accordion-item/AccordionItem.module.scss rename to src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/AccordionItem.module.scss diff --git a/src/apps/admin/src/skills-manager/components/accordion/accordion-item/AccordionItem.tsx b/src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/AccordionItem.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/accordion-item/AccordionItem.tsx rename to src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/AccordionItem.tsx diff --git a/src/apps/admin/src/skills-manager/components/accordion/accordion-item/index.ts b/src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/accordion-item/index.ts rename to src/apps/skills-manager/src/skills-manager/components/accordion/accordion-item/index.ts diff --git a/src/apps/admin/src/skills-manager/components/accordion/index.ts b/src/apps/skills-manager/src/skills-manager/components/accordion/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/accordion/index.ts rename to src/apps/skills-manager/src/skills-manager/components/accordion/index.ts diff --git a/src/apps/admin/src/skills-manager/components/actions-menu/ActionsMenu.module.scss b/src/apps/skills-manager/src/skills-manager/components/actions-menu/ActionsMenu.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/actions-menu/ActionsMenu.module.scss rename to src/apps/skills-manager/src/skills-manager/components/actions-menu/ActionsMenu.module.scss diff --git a/src/apps/admin/src/skills-manager/components/actions-menu/ActionsMenu.tsx b/src/apps/skills-manager/src/skills-manager/components/actions-menu/ActionsMenu.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/actions-menu/ActionsMenu.tsx rename to src/apps/skills-manager/src/skills-manager/components/actions-menu/ActionsMenu.tsx diff --git a/src/apps/admin/src/skills-manager/components/actions-menu/index.ts b/src/apps/skills-manager/src/skills-manager/components/actions-menu/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/actions-menu/index.ts rename to src/apps/skills-manager/src/skills-manager/components/actions-menu/index.ts diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/BulkEditor.module.scss b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/BulkEditor.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/BulkEditor.module.scss rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/BulkEditor.module.scss diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/BulkEditor.tsx b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/BulkEditor.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/BulkEditor.tsx rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/BulkEditor.tsx diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.module.scss b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.module.scss rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.module.scss diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.tsx b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.tsx rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/ArchiveSkillsModal.tsx diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/index.ts b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/archive-skills-modal/index.ts rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/archive-skills-modal/index.ts diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/index.ts b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/index.ts rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/index.ts diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.module.scss b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.module.scss rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.module.scss diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.tsx b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.tsx rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/MoveSkillsModal.tsx diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/index.ts b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/move-skills-modal/index.ts rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/move-skills-modal/index.ts diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.module.scss b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.module.scss rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.module.scss diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.tsx b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.tsx rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/ReplaceSkillsModal.tsx diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/index.ts b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/replace-skills-modal/index.ts rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/replace-skills-modal/index.ts diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/search-skill-input/SearchSkillInput.tsx b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/search-skill-input/SearchSkillInput.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/search-skill-input/SearchSkillInput.tsx rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/search-skill-input/SearchSkillInput.tsx diff --git a/src/apps/admin/src/skills-manager/components/bulk-editor/search-skill-input/index.ts b/src/apps/skills-manager/src/skills-manager/components/bulk-editor/search-skill-input/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/bulk-editor/search-skill-input/index.ts rename to src/apps/skills-manager/src/skills-manager/components/bulk-editor/search-skill-input/index.ts diff --git a/src/apps/admin/src/skills-manager/components/categories-accordion/CategoriesAccordion.module.scss b/src/apps/skills-manager/src/skills-manager/components/categories-accordion/CategoriesAccordion.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/categories-accordion/CategoriesAccordion.module.scss rename to src/apps/skills-manager/src/skills-manager/components/categories-accordion/CategoriesAccordion.module.scss diff --git a/src/apps/admin/src/skills-manager/components/categories-accordion/CategoriesAccordion.tsx b/src/apps/skills-manager/src/skills-manager/components/categories-accordion/CategoriesAccordion.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/categories-accordion/CategoriesAccordion.tsx rename to src/apps/skills-manager/src/skills-manager/components/categories-accordion/CategoriesAccordion.tsx diff --git a/src/apps/admin/src/skills-manager/components/categories-accordion/index.ts b/src/apps/skills-manager/src/skills-manager/components/categories-accordion/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/categories-accordion/index.ts rename to src/apps/skills-manager/src/skills-manager/components/categories-accordion/index.ts diff --git a/src/apps/admin/src/skills-manager/components/category-modal/CategoryModal.module.scss b/src/apps/skills-manager/src/skills-manager/components/category-modal/CategoryModal.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/category-modal/CategoryModal.module.scss rename to src/apps/skills-manager/src/skills-manager/components/category-modal/CategoryModal.module.scss diff --git a/src/apps/admin/src/skills-manager/components/category-modal/CategoryModal.tsx b/src/apps/skills-manager/src/skills-manager/components/category-modal/CategoryModal.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/category-modal/CategoryModal.tsx rename to src/apps/skills-manager/src/skills-manager/components/category-modal/CategoryModal.tsx diff --git a/src/apps/admin/src/skills-manager/components/category-modal/category-form.config.ts b/src/apps/skills-manager/src/skills-manager/components/category-modal/category-form.config.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/category-modal/category-form.config.ts rename to src/apps/skills-manager/src/skills-manager/components/category-modal/category-form.config.ts diff --git a/src/apps/admin/src/skills-manager/components/category-modal/index.ts b/src/apps/skills-manager/src/skills-manager/components/category-modal/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/category-modal/index.ts rename to src/apps/skills-manager/src/skills-manager/components/category-modal/index.ts diff --git a/src/apps/admin/src/skills-manager/components/index.ts b/src/apps/skills-manager/src/skills-manager/components/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/index.ts rename to src/apps/skills-manager/src/skills-manager/components/index.ts diff --git a/src/apps/admin/src/skills-manager/components/more-actions-menu/MoreActionsMenu.module.scss b/src/apps/skills-manager/src/skills-manager/components/more-actions-menu/MoreActionsMenu.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/more-actions-menu/MoreActionsMenu.module.scss rename to src/apps/skills-manager/src/skills-manager/components/more-actions-menu/MoreActionsMenu.module.scss diff --git a/src/apps/admin/src/skills-manager/components/more-actions-menu/MoreActionsMenu.tsx b/src/apps/skills-manager/src/skills-manager/components/more-actions-menu/MoreActionsMenu.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/more-actions-menu/MoreActionsMenu.tsx rename to src/apps/skills-manager/src/skills-manager/components/more-actions-menu/MoreActionsMenu.tsx diff --git a/src/apps/admin/src/skills-manager/components/more-actions-menu/index.ts b/src/apps/skills-manager/src/skills-manager/components/more-actions-menu/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/more-actions-menu/index.ts rename to src/apps/skills-manager/src/skills-manager/components/more-actions-menu/index.ts diff --git a/src/apps/admin/src/skills-manager/components/page-header/PageHeader.module.scss b/src/apps/skills-manager/src/skills-manager/components/page-header/PageHeader.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/page-header/PageHeader.module.scss rename to src/apps/skills-manager/src/skills-manager/components/page-header/PageHeader.module.scss diff --git a/src/apps/admin/src/skills-manager/components/page-header/PageHeader.tsx b/src/apps/skills-manager/src/skills-manager/components/page-header/PageHeader.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/page-header/PageHeader.tsx rename to src/apps/skills-manager/src/skills-manager/components/page-header/PageHeader.tsx diff --git a/src/apps/admin/src/skills-manager/components/page-header/index.ts b/src/apps/skills-manager/src/skills-manager/components/page-header/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/page-header/index.ts rename to src/apps/skills-manager/src/skills-manager/components/page-header/index.ts diff --git a/src/apps/admin/src/skills-manager/components/search-input/SearchInput.module.scss b/src/apps/skills-manager/src/skills-manager/components/search-input/SearchInput.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/search-input/SearchInput.module.scss rename to src/apps/skills-manager/src/skills-manager/components/search-input/SearchInput.module.scss diff --git a/src/apps/admin/src/skills-manager/components/search-input/SearchInput.tsx b/src/apps/skills-manager/src/skills-manager/components/search-input/SearchInput.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/search-input/SearchInput.tsx rename to src/apps/skills-manager/src/skills-manager/components/search-input/SearchInput.tsx diff --git a/src/apps/admin/src/skills-manager/components/search-input/index.ts b/src/apps/skills-manager/src/skills-manager/components/search-input/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/search-input/index.ts rename to src/apps/skills-manager/src/skills-manager/components/search-input/index.ts diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/SkillModal.module.scss b/src/apps/skills-manager/src/skills-manager/components/skill-modals/SkillModal.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/SkillModal.module.scss rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/SkillModal.module.scss diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/SkillModal.tsx b/src/apps/skills-manager/src/skills-manager/components/skill-modals/SkillModal.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/SkillModal.tsx rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/SkillModal.tsx diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/index.ts b/src/apps/skills-manager/src/skills-manager/components/skill-modals/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/index.ts rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/index.ts diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.module.scss b/src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.module.scss rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.module.scss diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.tsx b/src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.tsx rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/SimilarSkillsDropdown.tsx diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/index.ts b/src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/similar-skills-dropdown/index.ts rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/similar-skills-dropdown/index.ts diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/skill-form/SkillForm.module.scss b/src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/SkillForm.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/skill-form/SkillForm.module.scss rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/SkillForm.module.scss diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/skill-form/SkillForm.tsx b/src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/SkillForm.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/skill-form/SkillForm.tsx rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/SkillForm.tsx diff --git a/src/apps/admin/src/skills-manager/components/skill-modals/skill-form/index.ts b/src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/skill-modals/skill-form/index.ts rename to src/apps/skills-manager/src/skills-manager/components/skill-modals/skill-form/index.ts diff --git a/src/apps/admin/src/skills-manager/components/skills-list/SkillsList.module.scss b/src/apps/skills-manager/src/skills-manager/components/skills-list/SkillsList.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/components/skills-list/SkillsList.module.scss rename to src/apps/skills-manager/src/skills-manager/components/skills-list/SkillsList.module.scss diff --git a/src/apps/admin/src/skills-manager/components/skills-list/SkillsList.tsx b/src/apps/skills-manager/src/skills-manager/components/skills-list/SkillsList.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/components/skills-list/SkillsList.tsx rename to src/apps/skills-manager/src/skills-manager/components/skills-list/SkillsList.tsx diff --git a/src/apps/admin/src/skills-manager/components/skills-list/index.ts b/src/apps/skills-manager/src/skills-manager/components/skills-list/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/components/skills-list/index.ts rename to src/apps/skills-manager/src/skills-manager/components/skills-list/index.ts diff --git a/src/apps/admin/src/skills-manager/config/constants.ts b/src/apps/skills-manager/src/skills-manager/config/constants.ts similarity index 100% rename from src/apps/admin/src/skills-manager/config/constants.ts rename to src/apps/skills-manager/src/skills-manager/config/constants.ts diff --git a/src/apps/admin/src/skills-manager/config/index.ts b/src/apps/skills-manager/src/skills-manager/config/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/config/index.ts rename to src/apps/skills-manager/src/skills-manager/config/index.ts diff --git a/src/apps/admin/src/skills-manager/context/index.ts b/src/apps/skills-manager/src/skills-manager/context/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/context/index.ts rename to src/apps/skills-manager/src/skills-manager/context/index.ts diff --git a/src/apps/admin/src/skills-manager/context/skills-manager.context.tsx b/src/apps/skills-manager/src/skills-manager/context/skills-manager.context.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/context/skills-manager.context.tsx rename to src/apps/skills-manager/src/skills-manager/context/skills-manager.context.tsx diff --git a/src/apps/admin/src/skills-manager/context/use-skills-bulk-editor-context.tsx b/src/apps/skills-manager/src/skills-manager/context/use-skills-bulk-editor-context.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/context/use-skills-bulk-editor-context.tsx rename to src/apps/skills-manager/src/skills-manager/context/use-skills-bulk-editor-context.tsx diff --git a/src/apps/admin/src/skills-manager/index.ts b/src/apps/skills-manager/src/skills-manager/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/index.ts rename to src/apps/skills-manager/src/skills-manager/index.ts diff --git a/src/apps/admin/src/skills-manager/landing-page/LandingPage.module.scss b/src/apps/skills-manager/src/skills-manager/landing-page/LandingPage.module.scss similarity index 100% rename from src/apps/admin/src/skills-manager/landing-page/LandingPage.module.scss rename to src/apps/skills-manager/src/skills-manager/landing-page/LandingPage.module.scss diff --git a/src/apps/admin/src/skills-manager/landing-page/LandingPage.tsx b/src/apps/skills-manager/src/skills-manager/landing-page/LandingPage.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/landing-page/LandingPage.tsx rename to src/apps/skills-manager/src/skills-manager/landing-page/LandingPage.tsx diff --git a/src/apps/admin/src/skills-manager/landing-page/index.ts b/src/apps/skills-manager/src/skills-manager/landing-page/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/landing-page/index.ts rename to src/apps/skills-manager/src/skills-manager/landing-page/index.ts diff --git a/src/apps/admin/src/skills-manager/lib/index.ts b/src/apps/skills-manager/src/skills-manager/lib/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/lib/index.ts rename to src/apps/skills-manager/src/skills-manager/lib/index.ts diff --git a/src/apps/admin/src/skills-manager/lib/skills.utils.ts b/src/apps/skills-manager/src/skills-manager/lib/skills.utils.ts similarity index 100% rename from src/apps/admin/src/skills-manager/lib/skills.utils.ts rename to src/apps/skills-manager/src/skills-manager/lib/skills.utils.ts diff --git a/src/apps/admin/src/skills-manager/services/index.ts b/src/apps/skills-manager/src/skills-manager/services/index.ts similarity index 100% rename from src/apps/admin/src/skills-manager/services/index.ts rename to src/apps/skills-manager/src/skills-manager/services/index.ts diff --git a/src/apps/admin/src/skills-manager/services/skills-categories.service.ts b/src/apps/skills-manager/src/skills-manager/services/skills-categories.service.ts similarity index 100% rename from src/apps/admin/src/skills-manager/services/skills-categories.service.ts rename to src/apps/skills-manager/src/skills-manager/services/skills-categories.service.ts diff --git a/src/apps/admin/src/skills-manager/services/skills.service.ts b/src/apps/skills-manager/src/skills-manager/services/skills.service.ts similarity index 100% rename from src/apps/admin/src/skills-manager/services/skills.service.ts rename to src/apps/skills-manager/src/skills-manager/services/skills.service.ts diff --git a/src/apps/admin/src/skills-manager/skills-manager.routes.tsx b/src/apps/skills-manager/src/skills-manager/skills-manager.routes.tsx similarity index 100% rename from src/apps/admin/src/skills-manager/skills-manager.routes.tsx rename to src/apps/skills-manager/src/skills-manager/skills-manager.routes.tsx diff --git a/src/config/constants.ts b/src/config/constants.ts index a7287a590..cab50f7eb 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -1,5 +1,5 @@ export enum AppSubdomain { - admin = 'manage', + skillsManager = 'manage', accounts = 'account-settings', devCenter = 'devcenter', earn = 'earn', @@ -14,7 +14,7 @@ export enum AppSubdomain { } export enum ToolTitle { - admin = 'Administration', + skillsManager = 'Manage Skills', accounts = 'Account Settings', devCenter = 'Dev Center', earn = 'Opportunity Feed', From 526be425ea61fdab8a1353e35c02a6e56d2a8bb4 Mon Sep 17 00:00:00 2001 From: Vasilica Olariu Date: Fri, 10 Jan 2025 14:04:06 +0200 Subject: [PATCH 2/3] PM-462 - platformui deployment docs --- .../GetStartedCardsContainer.tsx | 21 +- .../getting-started/GettingStartedGuide.md | 181 ++++++++++++++++++ .../GettingStartedGuide.module.scss | 40 ++++ .../getting-started/GettingStartedGuide.tsx | 33 ++++ src/apps/dev-center/src/dev-center.routes.tsx | 7 + 5 files changed, 280 insertions(+), 2 deletions(-) create mode 100644 src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.md create mode 100644 src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.module.scss create mode 100644 src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.tsx diff --git a/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx b/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx index a34fbbaae..b15bfa07d 100644 --- a/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx +++ b/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx @@ -7,6 +7,7 @@ import { DevCenterCard } from '../../dev-center-card' import { rootRoute } from '../../../../../dev-center.routes' import styles from './GetStartedCardsContainer.module.scss' +import { BookOpenIcon } from '@heroicons/react/outline' const GetStartedCardsContainer: FC = () => (
@@ -29,15 +30,31 @@ const GetStartedCardsContainer: FC = () => ( } icon={} - title='Platform UI Storybook' + title='Platform UI' titleClass={styles.apiTitle} - description='Explore the Platform UI Storybook for UI development.' + description='Check out instructions on how to get started with the Platform UI.' button={( + )} + /> + } + icon={} + title='Platform UI Storybook' + titleClass='' + description='Explore the Platform UI Storybook for UI development.' + button={( + )} diff --git a/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.md b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.md new file mode 100644 index 000000000..68be541c1 --- /dev/null +++ b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.md @@ -0,0 +1,181 @@ +# Platform UI + +The Platform UI is the official Topcoder web app to host all modern user interfaces to be used by all users. + +All future user interfaces at Topcoder will be implemented here. Pre-existing user interfaces will be ported to here over time until this is the only user interface any user sees when interacting with Topcoder. + +## Local Environment Setup + +### Install VS Code + +Preferably, use the VS Code IDE for development. + +[https://code.visualstudio.com/download](https://code.visualstudio.com/download) + +### GIT + +Install git on your local machine. This is trivial for working in the community. +You can follow these guides for installing GIT: + +- [Windows](https://local.topcoder-dev.com/devcenter/getting-started#23-install-git) +- [Linux](https://local.topcoder-dev.com/devcenter/getting-started#197-install-git) + +### nvm + +Use the node version manager [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to easily and safely manage the required version of NodeJS (aka, node). Download and install it per the instructions for your development operating system. Installing a version of node via `nvm` will also install `npm`. + +> **NOTE:** If the nvm command is not working it might be because the installation failed to update your paths variable properly. To try and fix this try installing nvm again using sudo. + +Once nvm is installed, run: + +```sh +nvm install +``` + +At the root of the project directory you'll notice a file called `.nvmrc` which specifies the node version used by the project. The command `nvm use` will use the version specified in the file if no version is supplied on the command line. +See [the nvm Github README](https://github.com/nvm-sh/nvm/blob/master/README.md#nvmrc) for more information on setting this up. + +> **NOTE:** The current node version mentioned in the `.nvmrc` is `22.13.0` + +You can verify the versions of `nvm`, `node`, and `npm` using the commands below. + +| Command | Supported Version | +| ------------- | ----------------- | +| `% npm -v` | 10.9.2 | +| `% node -v` | v22.13.0 | + +> **NOTE:** The `yarn start` command requires the `NVM_DIR` env variable is set. + +```sh +export NVM_DIR=~/.nvm +``` + +### Hosting + +You will need to add the following line to your hosts file. The hosts file is normally located at `/etc/hosts` (Mac & Linux) or %SYSTEMROOT%\System32\drivers\etc\hosts (Windows). Do not overwrite the existing localhost entry also pointing to 127.0.0.1. + +``` +127.0.0.1 local.topcoder-dev.com +``` + +### Building and serving the application + +1. Open a terminal +2. Run the following commands + +```sh +git clone https://github.com/topcoder-platform/platform-ui.git +cd platform-ui +yarn install +yarn start +``` + +3. Go to https://local.topcoder-dev.com + +> **NOTE**: The site must run on port 443 in order for auth0 to work and for the site to load properly. Mac users will need to run the app with elevated permissions, as in: + +```sh +sudo yarn start +``` + +Run following command to allow node to run apps on ports lowert than 500 (Mac & Linux): + +```sh +sudo setcap 'cap_net_bind_service=+ep' `which node` +``` + +### Local SSL + +SSL is required for authentication to work properly. + +The `yarn start` command serves the site using the cert and key in the /ssl directory, which authorize the `https://local.topcoder-dev.com` URL. + +By overriding the app to use **port 443**, you can use the authorized URL and trust the root CA to avoid SSL errors in the browser. + +> **NOTE:** Mac and Linux users will require running the app with elevated permissions in order to use a port lower than 500. + +Easy way to overcome elevated permissions is to make use of: + +```sh +sudo setcap 'cap_net_bind_service=+ep' `which node` +``` + +For easier development, it is recommended that you add this certificate to your trusted root authorities and as a trused cert in your browser. Google your browser and OS for more info on how to trust cert authorities. + +Otherwise, you will need to override the exception each time you load the site. Firefox users may need to user an incognito browser in order to override the exception. + +## yarn Commands + +| Command | Description | +| ------------------- | -------------------------------------------------------------------------------------- | +| yarn start | Serve dev mode build with the default config | +| yarn build | Build dev mode build with the default config and outputs static files in /build | +| yarn build:prod | Build prod mode build with the prod config and outputs static files in /build | +| yarn demo | Serves the built files (by running yarn:build) for local testing | +| yarn lint | Run eslint against js/x and ts/x files and outputs report | +| yarn lint:fix | Run eslint against js/x and ts/x files, fixes auto-fixable issues, and outputs report | +| yarn sb | Start the storybook dev server | +| yarn sb:build | Build the assets for storybook | + +## App specific setup + +Each Application can have its own setup requirements. Please see each apps's README for further information. + +### Applications hosted under Platform UI + +#### Platform App +This is the "router" app under the whole sum of all Platform UI applications. It will just load all applications and serve one based on the specific route +It also renders the [Universal Navigation](https://github.com/topcoder-platform/universal-navigation)'s header & footer. + +Located `src/apps/platform`. + +#### Account Settings +App that manages user's own settings. + +Located `src/apps/accounts`. + +#### Dev Center +A community-led project to document how to work with Topcoder internal applications. + +Located `src/apps/dev-center`. + +#### Gamification Admin +Application that allows administrators to CRUD badges and de/assign them to specific users. + +Located `src/apps/gamification-admin`. + +#### Learn +Application that serves 3rd-party educational content. + +Located `src/apps/learn`. + +#### Onboarding App +Application that helps new users with the onboarding on our platform. + +Located `src/apps/onboarding`. + +#### Profiles App +Application that allows users to manage their own profile data, and allows visitors to view user details and participation statistics for a specific member. + +Located `src/apps/profiles`. + +#### Talent Search App +This is an internal app for finding members based on skills and other search facets. + +Located `src/apps/talent-search`. + +#### Skills Manager +Admin app that allows one to manage the standardized skills. + +Located `src/apps/skills-manager`. + +#### Self Service +Application that allows customers to submit/start challenges self-service. + +Located `src/apps/self-service`. + +#### Wallet App +This app allows members to manage details regarding their payments. + +Located `src/apps/wallet`. + diff --git a/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.module.scss b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.module.scss new file mode 100644 index 000000000..f08c71140 --- /dev/null +++ b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.module.scss @@ -0,0 +1,40 @@ +@import "@libs/ui/styles/includes"; +@import '../../../styles/variables'; + +.contentLayout { + width: 100%; + padding-bottom: 0; + + .contentLayout-outer { + width: 100%; + + .contentLayout-inner { + width: 100%; + overflow: visible; + + padding-top: $sp-4; + + h4 { + margin-top: $sp-4; + } + + table { + th { + font-weight: bold; + } + td { + border: 1px solid; + padding: $sp-1 $sp-4; + } + } + } + } +} + +@include ltelg { + .contentLayout { + .contentLayout-outer { + padding: 0 $sp-4; + } + } +} diff --git a/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.tsx b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.tsx new file mode 100644 index 000000000..e56d6b2e5 --- /dev/null +++ b/src/apps/dev-center/src/dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide.tsx @@ -0,0 +1,33 @@ +import * as React from 'react' + +import { Breadcrumb, BreadcrumbItemModel, ContentLayout } from '~/libs/ui' + +import { rootRoute, toolTitle } from '../../../dev-center.routes' +import { LayoutDocHeader, MarkdownDoc } from '../../../dev-center-lib/MarkdownDoc' +import useMarkdown from '../../../dev-center-lib/hooks/useMarkdown' + +import gettingStartedGuide from './GettingStartedGuide.md' +import styles from './GettingStartedGuide.module.scss' + +export const GettingStartedGuide: React.FC = () => { + const { doc, toc, title }: ReturnType = useMarkdown({ uri: gettingStartedGuide }) + const breadcrumb: Array = React.useMemo(() => [ + { name: toolTitle, url: rootRoute || '/' }, + { name: title, url: '#' }, + ], [title]) + + return ( + + + + + + + ) +} + +export default GettingStartedGuide diff --git a/src/apps/dev-center/src/dev-center.routes.tsx b/src/apps/dev-center/src/dev-center.routes.tsx index a8be4c0c4..2bc4fb805 100644 --- a/src/apps/dev-center/src/dev-center.routes.tsx +++ b/src/apps/dev-center/src/dev-center.routes.tsx @@ -4,6 +4,9 @@ import { lazyLoad, LazyLoadedComponent, PlatformRoute } from '~/libs/core' const Storybook: LazyLoadedComponent = lazyLoad(() => import('./dev-center-pages/platform-ui-app/storybook/Storybook')) +const PlatformUIGettingStarted: LazyLoadedComponent + = lazyLoad(() => import('./dev-center-pages/platform-ui-app/getting-started/GettingStartedGuide')) + const GettingStartedGuide: LazyLoadedComponent = lazyLoad(() => import('./dev-center-pages/community-app/getting-started/GettingStartedGuide')) @@ -24,6 +27,10 @@ export const devCenterRoutes: ReadonlyArray = [ element: , route: '/storybook', }, + { + element: , + route: '/platform-ui', + }, { element: , route: '/getting-started', From ee0d667dd259dfdcd30156d851e0d704fc61177d Mon Sep 17 00:00:00 2001 From: Vasilica Olariu Date: Fri, 10 Jan 2025 14:09:50 +0200 Subject: [PATCH 3/3] lint fix --- .../GetStartedCardsContainer/GetStartedCardsContainer.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx b/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx index b15bfa07d..0f57ccc03 100644 --- a/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx +++ b/src/apps/dev-center/src/dev-center-pages/community-app/landing-page/dev-center-get-started/GetStartedCardsContainer/GetStartedCardsContainer.tsx @@ -1,5 +1,6 @@ import { FC } from 'react' +import { BookOpenIcon } from '@heroicons/react/outline' import { LinkButton } from '~/libs/ui' import { ApiCornerIcon, ApiIcon, CommunityAppCornerIcon, CommunityAppIcon } from '../../../../../assets/i' @@ -7,7 +8,6 @@ import { DevCenterCard } from '../../dev-center-card' import { rootRoute } from '../../../../../dev-center.routes' import styles from './GetStartedCardsContainer.module.scss' -import { BookOpenIcon } from '@heroicons/react/outline' const GetStartedCardsContainer: FC = () => (