module-federation-setup

Included with Lifetime

$97 forever

Set up Vite Module Federation for React microfrontends with proper shared dependencies and route exposure

Web Dev

What this skill does


# Module Federation Setup Skill

Use this skill when creating or configuring Module Federation for a new or existing React microfrontend in the StyleMate platform.

## When to Use
- Setting up a new microfrontend project
- Configuring federation.config.ts
- Debugging module federation loading issues
- Adding shared dependencies
- Exposing routes to the shell application

## What This Skill Does

### 1. Federation Config Creation
Creates proper `federation.config.ts` with:
- Unique module name based on context
- Route exposure configuration
- Shared dependencies (React, MUI, Router, etc.)
- Proper singleton settings
- Remote entry configuration

### 2. Vite Config Integration
Ensures `vite.config.ts` includes:
- Module Federation plugin
- Proxy configuration for API calls
- Build optimizations
- Development server settings

### 3. Route Export Setup
Configures `src/app/routes.tsx` to:
- Export routes with proper metadata
- Include authorization requirements
- Define route guards
- Set up lazy loading

### 4. Shell Integration
Provides instructions for:
- Adding remote to shell's vite.config.ts
- Importing routes in shell router
- Configuring navigation menu items

## Expected Inputs
- Context name (e.g., "staff", "appointments", "payments")
- Port number for development server
- Required shared dependencies
- Routes to expose

## Deliverables
- Complete federation.config.ts file
- Updated vite.config.ts with proxy settings
- Route export configuration
- Shell integration instructions

## Example Usage
```
Please set up Module Federation for the staff microfront. It will run on port 3003
and needs to expose routes for employee management, scheduling, and timesheets.
```

## Technical Details

### Shared Dependencies Configuration
```typescript
shared: {
  'react': { singleton: true, requiredVersion: '^19.0.0' },
  'react-dom': { singleton: true, requiredVersion: '^19.0.0' },
  'react-router-dom': { singleton: true },
  '@mui/material': { singleton: true },
  '@emotion/react': { singleton: true },
  '@emotion/styled': { singleton: true },
  'axios': { singleton: true }
}
```

### Route Metadata Requirements
```typescript
interface RouteMetadata {
  label: string;
  allowedRoles: string[];
  requireEmailConfirmed: boolean;
  requireBusiness: boolean;
  requireTwoFactor?: boolean;
}
```

## Validation Steps
1. Build the microfrontend: `npm run build`
2. Check remoteEntry.js is generated
3. Test route exposure in development mode
4. Verify shared dependencies are deduplicated
5. Test loading in shell application

Files: 1

Size: 2.6 KB

Complexity: 5/100

Category: Web Dev

Source: https://github.com/usmanali4073/stylemate-plugins/tree/main/stylemate-architecture/skills/module-federation-setup

Related in Web Dev

generating-lwc-components

Included

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use generating-apex), Aura components, or Visualforce.

Web Devscripts

tanstack-query

Included

Manage server state in React with TanStack Query v5. Set up queries with useQuery, mutations with useMutation, configure QueryClient caching strategies, implement optimistic updates, and handle infinite scroll with useInfiniteQuery. Use when: setting up data fetching in React projects, migrating from v4 to v5, or fixing object syntax required errors, query callbacks removed issues, cacheTime renamed to gcTime, isPending vs isLoading confusion, keepPreviousData removed problems.

Web Devscripts

document-processor-api

Included

Process documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.

Web Devscripts

nutrient-document-processing

Included

Web Devscripts

tanstack-query

Included

Manage server state in React with TanStack Query v5. Covers useMutationState, simplified optimistic updates, throwOnError, network mode (offline/PWA), and infiniteQueryOptions. Use when setting up data fetching, fixing v4→v5 migration errors (object syntax, gcTime, isPending, keepPreviousData), or debugging SSR/hydration issues with streaming server components.

Web Devscripts

accelint-nextjs-best-practices

Included

Next.js performance optimization and best practices. Use when writing Next.js code (App Router or Pages Router); implementing Server Components, Server Actions, or API routes; optimizing RSC serialization, data fetching, or server-side rendering; reviewing Next.js code for performance issues; fixing authentication in Server Actions; or implementing Suspense boundaries, parallel data fetching, or request deduplication.

Web Devscripts