Skip to main content

Geekle Demand App

This is the Demand App of the entire Geekle package. It is used to manage the Supply organizations and users.

Main​

main.tsx is where the App starts. We instantiate a new GeekleDemandAppTemplate with it's options and dependencies; then initialize and render a React App.

Dependencies​

The dependencies are services and API's needed for the Demand App.

  • authApi: The auth API for authentication
  • catalogApi: The Catalog API service for the jobs created by organization
  • chatApi: Chat API for messaging between organizations and users
  • chatSocketApi: Web sockets for chat
  • orderApi: Order API service for job applications
  • organizationApi: The organization API service
  • sessionService: The service which handles the session management
  • userApi: The user API service

Opts​

The options for the Demand App.

Block Pages​

The blockPages option is one of the main options. Here are the components used for the Demand site:

  • createRedirect: Simple redirect to the top index page

    • Settings
      • options: Navigation options for the redirect
      • to: Name of the blockPage to redirect to
    • Validators
      • None

  • createSections: My Page landing page sections

    • Settings
      • components: An array of components to display on the landing page
        • createMyPageJobActivity: Displays call to action buttons to user's job activities
          • Settings
            • orderListRoute: Route to order/job applications page
        • createNewProductsList: List of latest products/jobs
          • Settings
            • catalogApi: The Catalog API service for the jobs created by organization
            • numberOfProducts: Number of products/jobs to display
            • productRoute: Product/job details page
            • showSubtitle: Display the subtitle
            • titleAlignment: Title alignment
    • Validators
      • emailVerified: Checks if user's email has been verified
      • isLoggedIn: When the user is not logged in, it redirects to the landing page
      • signUpWizardCompleted: Checks if sign up wizard has been completed

  • createSections: Landing page sections

    • Settings
      • components: An array of components to display on the landing page
        • createLandingHero: Landing page hero section
          • Settings
            • byline: ReactNode component to display the byline text
            • imageUrl: Image URL for the hero section
            • showSecondaryText: Boolean to display secondary text
            • showTertiaryText: Boolean to display tertiary text
            • signupRoute: The sign up page route
        • createLandingMerits: Display merit items on landing page
          • Settings
            • meritItems: Merit items to display on the landing page
            • signupRoute: The sign up page route
        • createNewProductsList: List of latest products/jobs
          • Settings
            • catalogApi: The Catalog API service for the jobs created by organization
            • numberOfProducts: Number of products/jobs to display
            • productRoute: Product/job details page
            • showSubtitle: Display the subtitle
            • titleAlignment: Title alignment
        • createLandingHowToUse: How to use section of the landing page
          • Settings
            • signupRoute: The sign up page route
            • stepItems: Steps on how to use items
        • createLandingFAQ: FAQ section
          • Settings
            • faqItems: The FAQ items
    • Validators
      • emailVerified: Checks if user's email has been verified
      • isNotLoggedIn: When the user is not logged in, it redirects to the 'my page' page
      • signUpWizardCompleted: Checks if sign up wizard has been completed

  • createLogin: THe login form

    • Settings
      • alreadyVerifiedRoute: Route to page when user is logged in and verified
      • authApi: The Authentication API service
      • showSignupLink: The link to sign up page
      • userApi: The User API service
    • Validators
      • None

  • createResetPasswordRequest: Email form to request password reset

    • Settings
      • userApi: The User API service
    • Validators
      • None

  • createResetPasswordSubmit: Reset password form

    • Settings
      • passwordValidateStrategy: The strategy to validate the password
      • userApi: The User API service
    • Validators
      • None

  • createResetPasswordSuccess: Simple page after successful password reset

    • Settings
      • userApi: The User API service
    • Validators
      • None

  • createLogout: Logout page

    • Settings
      • authApi: The Authentication API service
      • logoutRedirect: Page to redirect to upon logging out
    • Validators
      • None

  • createSignUp: The sign up form page

    • Settings
      • alreadyVerifiedRoute: Route to page when user is logged in and verified
      • authApi: The Authentication API service
      • homeRoute: Route to home page
      • passwordValidateStrategy: The strategy to validate the password
      • privacyPolicyUrl: The URL of the private policy page
      • userAgreementUrl: The URL of the user agreement page
      • userApi: The User API service
    • Validators
      • None

  • createVerifyEmailSuccess:

    • Settings
      • userApi: The User API service
      • verifiedRoute: Route to the page upon email verify
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createWizard: Wizard page for user create

    • Settings
      • pages: The pages of the wizard
        • Settings
          • createWizardBaseInfo: Basic info for the wizard
          • createWizardCategorySelect: Select job type page
            • Settings:
              • catalogApi: The Catalog API service for the jobs created by organization
          • createWizardCategoryExperience: Select job experience page
            • Settings:
              • catalogApi: The Catalog API service for the jobs created by organization
          • createWizardAttributeItemsSelect: Select skills
            • Settings:
              • attributeName: The name of the attribute to retrieve from
              • catalogApi: The Catalog API service for the jobs created by organization
          • createWizardDesiredCompensation: Select desired compensation
          • createGeekleInitialWizardSubmit: Submit wizard
            • Settings:
              • userApi: The User API service
    • Validators
      • signUpWizardCompleted: Checks if sign up wizard has been completed

  • createProductSearch: Search page for product/jobs

    • Settings
      • catalogApi: The Catalog API service for the jobs created by organization
      • filterProductsRoute: Route to the page for applying filters
      • numberOfProductsPerPage: Number of products per page
      • productRoute: Route to product/job details page
    • Validators
      • None

  • createProductFilter: Filter jobs page

    • Settings
      • attributeName: The name of the attribute to retrieve from
      • catalogApi: The Catalog API service for the jobs created by organization
      • searchProductsRoute: Route to search products/jobs page
    • Validators
      • None

  • createProductDetailsPageForDemand: Products/jobs details page for the demand site

    • Settings
      • catalogApi: The Catalog API service for the jobs created by organization
      • orderApi: Order API service for job applications
      • organizationShowRoute: Route to the organization/company details page
      • userApi: The User API service
    • Validators
      • None

  • createMyOrdersListPage: List of user's orders page

    • Settings
      • orderApi: Order API service for job applications
      • productRoute: The product page route
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createOrganizationDetailsPage: Organization/company details page

    • Settings
      • catalogApi: The Catalog API service for the jobs created by organization
      • organizationApi: The organization API service
      • organizationListRoute: Route to list of organizations/companies
    • Validators
      • None

  • createOrganizationJobPositionsListPage: List of the organization/company's jobs

    • Settings
      • catalogApi: The Catalog API service for the jobs created by organization
      • organizationApi: The organization API service
      • organizationShowRoute: Route to the organization/company details page
      • productRoute: The product page route
    • Validators
      • None

  • createListTopicsForUserBlock: Topics list for the user

    • Settings
      • chatApi: Chat API for messaging between organizations and users
      • chatShowRoute: Route to chats page
      • socketApi: Web sockets for chat
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createListMessagesForTopicBlock: List of messages for each topic

    • Settings
      • chatApi: Chat API for messaging between organizations and users
      • organizationApi: The organization API service
      • organizationShowRoute: Route to the organization/company details page
      • socketApi: Web sockets for chat
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createGroupedSettingsPage: Settings page

    • Settings
      • changeEmailRoute: Route to change email
      • changePasswordRoute: Route to change password
      • deactivateAccountRoute: Route to deactivate account
      • userApi: The User API service
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createChangeEmail: User settings to edit their email

    • Settings
      • cancelRoute: The page to go to upon cancelling settings update
      • successRoute: The page to go to upon successful settings update
      • userApi: The User API service
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createVerifyChangeEmailSuccess: Success page when updating email address

    • Settings
      • userApi: The User API service
      • verifiedRoute: Page to go to upon verification
    • Validators
      • None

  • createChangePassword:

    • Settings
      • cancelRoute: The page to go to upon cancelling password change
      • successRoute: The page to go to upon successful password change
      • forgotPasswordUrl: Forget password URL
      • userApi: The User API service
    • Validators
      • isLoggedIn: When the user is not logged in, it redirects to the login page

  • createDeactivateAccount: Account deactivation page

    • Settings
      • successRoute: The page to go to upon successful account deactivation
      • userApi: The User API service
    • Validators
      • None

  • createDeactivateSuccessAccount: Account deactivation success page

    • Settings
      • successRoute: Route to success
    • Validators
      • None