Documentation Index

Documentation Index

Welcome to the React MFE Shell documentation! This wiki contains comprehensive guides and references for using and extending the design system.

Main Documentation

• Home - Project overview and quick start
• Implementation Guide - Detailed implementation instructions
• Design Tokens - Comprehensive design token documentation
• GitHub Pages Setup - Demo deployment guide

Quick Links

Getting Started

# Install in your project
npm install @jonmatum/react-mfe-shell

# Or clone for development
git clone https://github.com/jonmatum/react-mfe-shell.git
cd react-mfe-shell
npm install
npm run dev

Design System Usage

import { 
  SettingsProvider, 
  Button, 
  Input, 
  Badge,
  tokens 
} from '@jonmatum/react-mfe-shell';

function App() {
  return (
    <SettingsProvider>
      <Button variant="primary">Hello World</Button>
    </SettingsProvider>
  );
}

Development Commands

npm run dev              # Start development server
npm run build:lib        # Build library
npm run build:demo       # Build demo
npm run test:run         # Run tests
npm run lint             # Lint code

Live Demo

View Interactive Demo

Additional Resources

• GitHub Repository
• Issues & Bug Reports
• Contributing Guidelines
• npm Package

---

Last updated: $(date) Auto-synced from repository documentation